Update instructions to run Jupyter notebooks#71
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Jupyter notebook documentation to include explicit installation and launch instructions. The changes clarify the setup process by adding the notebook installation step and providing the command to run notebooks.
Key Changes:
- Added Jupyter Notebook installation instruction to prerequisites
- Added explicit command to launch Jupyter notebooks using uv
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **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`. |
There was a problem hiding this comment.
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`. |
MichaelSun48
approved these changes
Nov 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding explicit uv command to run these once the notebook tool has been installed.