Skip to content

Commit 2841a08

Browse files
authored
Update instructions to run Jupyter notebooks (#71)
Adding explicit uv command to run these once the notebook tool has been installed.
1 parent 682bd4b commit 2841a08

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

agentex/docs/docs/development_guides/jupyter_notebooks.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Before starting, ensure you have:
1313

1414
1. **AgentEx server running locally** (see [Getting Started](https://github.com/scaleapi/scale-agentex#getting-started){target="_blank"})
1515
2. **AgentEx Python SDK installed**: `uv tool install agentex-sdk`
16-
3. **Your agent running**: `agentex agents run --manifest manifest.yaml`
16+
3. **Jupyter Notebook installed**: `uv tool install notebook`
17+
4. **Your agent running**: `agentex agents run --manifest manifest.yaml`
1718

1819
## The `dev.ipynb` Notebook
1920

@@ -24,7 +25,9 @@ When you run `agentex init`, a `dev.ipynb` notebook is automatically created in
2425
- **Working examples** tailored to your agent type (Sync or Async)
2526
- **Code snippets** demonstrating both streaming and non-streaming patterns
2627

27-
Simply open the notebook and run the cells to start testing your agent immediately. The examples below explain what's in the notebook and how to customize it for your needs.
28+
Simply open the notebook and run the cells to start testing your agent immediately - you can launch it with `uv run jupyter notebook dev.ipynb`.
29+
30+
The examples below explain what's in the notebook and how to customize it for your needs.
2831

2932
## Sync ACP Agents
3033

0 commit comments

Comments
 (0)