Skip to content

Update instructions to run Jupyter notebooks #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smoreinis merged 2 commits into from
Nov 10, 2025
Merged

Update instructions to run Jupyter notebooks #71

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78d4056
Update jupyter_notebooks.md
smoreinis Nov 10, 2025
77733b3
Merge branch 'main' into stas/notebook-docs
smoreinis Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions agentex/docs/docs/development_guides/jupyter_notebooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Before starting, ensure you have:

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

## The `dev.ipynb` Notebook

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

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.
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`.

Copilot AI Nov 10, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command uv run jupyter notebook dev.ipynb is inconsistent with the installation method shown in line 16. Since Jupyter was installed using uv tool install notebook, it should be launched with uv tool run notebook dev.ipynb or just notebook dev.ipynb (if the tool's bin directory is in PATH), not uv run.

Suggested change
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`.
Simply open the notebook and run the cells to start testing your agent immediately - you can launch it with `uv tool run notebook dev.ipynb`.

Copilot uses AI. Check for mistakes.

The examples below explain what's in the notebook and how to customize it for your needs.

## Sync ACP Agents

Expand Down
Loading