Skip to content

Commit ca1cff0

Browse files
Fix a typo in the weave README (#195)
Closes ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/advanced/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) Approvers: - Eric Evans II (https://github.com/ericevans-nv) URL: #195
1 parent 3c2360e commit ca1cff0

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

‎docs/source/guides/fine-grained-tracing-with-weave.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,11 @@ This setup enables logging trace data to W&B weave. The weave integration requir
5959
| `entity` (optional) | Your W&B username or team name | `"your-wandb-username-or-teamname"` |
6060

6161
### Step 4: Run Your Workflow
62-
From the root directory of the AIQ Toolkit library, execute your workflow as shown below:
62+
Install `simple_calculator` example using the instructions in the `examples/simple_calculator/README.md` guide.
63+
Run the workflow using `config-weave.yml` configuration file:
6364

6465
```bash
65-
aiq run --config_file examples/simple_calculator/configs/config.yml --input "Is the product of 2 * 4 greater than the current hour of the day?"
66+
aiq run --config_file examples/simple_calculator/configs/config-weave.yml --input "Is the product of 2 * 4 greater than the current hour of the day?"
6667
```
6768

6869
If it is your first time running the workflow, you will be prompted to login to W&B Weave.

‎examples/simple_calculator/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,13 @@ Workflow Result:
178178
### Examine the Traces in Phoenix
179179
Open your browser and navigate to `http://localhost:6006` to view the traces.
180180

181+
## Using Weave for Tracing
182+
You can use Weave to trace the workflow by following the instructions in the [Fine-grained Tracing with Weave](../../docs/source/guides/fine-grained-tracing-with-weave.md) guide.
183+
Sample usage:
184+
```bash
185+
aiq run --config_file examples/simple_calculator/configs/config-weave.yml --input "Is the product of 2 * 4 greater than the current hour of the day?"
186+
```
187+
181188
## Accuracy Evaluation
182189
The answers generated by the workflow can be evaluated using the [Tunable RAG Evaluator](../../docs/source/concepts/evaluate.md#tunable-rag-evaluator). A sample dataset is provided in `examples/simple_calculator/data/simple_calculator.json`.
183190

0 commit comments

Comments
 (0)