Skip to content

Commit ec45a89

Browse files
committed
docs: lint
1 parent 5bdeb29 commit ec45a89

File tree

2 files changed

+8
-19
lines changed

2 files changed

+8
-19
lines changed

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ clean: ## clean
2929
git clean -fdx
3030

3131
jupyterlab: ## jupyterlab
32+
pip uninstall -y pycrdt datalayer_pycrdt
33+
pip install datalayer_pycrdt
3234
jupyter lab \
3335
--port 8888 \
3436
--ServerApp.root_dir ./dev/content \

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Jupyter Clients
2727

2828
Jupyter AI Agents empowers **AI** models to **interact** with and **modify Jupyter Notebooks**. The agent is equipped with tools such as adding code cells, inserting markdown cells, executing code, enabling it to modify the notebook comprehensively based on user instructions or by reacting to the Jupyter notebook events.
2929

30-
This agent is **innovative** as it is designed to **operate on the entire notebook**, not just at the cell level, enabling more comprehensive and seamless modifications. The agent can also run separetely from the Jupyter server as the communication is achieved through RTC () via the [Jupyter NbModel Client](https://github.com/datalayer/jupyter-nbmodel-client) and the [Jupyter Kernel Client](https://github.com/datalayer/jupyter-kernel-client).
30+
This agent is **innovative** as it is designed to **operate on the entire Notebook**, not just at the cell level, enabling more comprehensive and seamless modifications.
31+
32+
The agent can also run separetely from the Jupyter server as the communication is achieved through RTC via the [Jupyter NbModel Client](https://github.com/datalayer/jupyter-nbmodel-client) and the [Jupyter Kernel Client](https://github.com/datalayer/jupyter-kernel-client).
3133

3234
The [LangChain Agent Framework](https://python.langchain.com/v0.1/docs/modules/agents/how_to/custom_agent) is used to manage the interactions between the AI model and the tools.
3335

@@ -69,15 +71,10 @@ We put here a quick example for a Out-Kernel Stateless Agent via CLI helping you
6971
Start JupyterLab, setting a `port` and a `token` to be reused by the agent, and create a notebook `test.ipynb`.
7072

7173
```bash
74+
# make jupyterlab
7275
jupyter lab --port 8888 --IdentityProvider.token MY_TOKEN
7376
```
7477

75-
You can also start JupyterLab with the following command.
76-
77-
```bash
78-
make jupyterlab
79-
```
80-
8178
Jupyter AI Agents supports multiple AI model providers (more information can be found on [this documentation page](https://jupyter-ai-agents.datalayer.tech/docs/models)).
8279

8380
The following takes you through an example with the Azure OpenAI provider. Read the [Azure Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai) to get the needed credentials and make sure you define them in the following `.env` file.
@@ -96,6 +93,7 @@ To use the Jupyter AI Agents, an easy way is to launch a CLI (update the Azure d
9693

9794
```bash
9895
# Prompt agent example.
96+
# make prompt
9997
jupyter-ai-agents prompt \
10098
--url http://localhost:8888 \
10199
--token MY_TOKEN \
@@ -105,18 +103,13 @@ jupyter-ai-agents prompt \
105103
--input "Create a matplotlib example"
106104
```
107105

108-
You can also start prompt with the following command.
109-
110-
```bash
111-
make prompt
112-
```
113-
114106
![Jupyter AI Agents](https://assets.datalayer.tech/jupyter-ai-agent/ai-agent-prompt-demo-terminal.gif)
115107

116108
**Explain Error Agent**
117109

118110
```bash
119111
# Explain Error agent example.
112+
# make explain-error
120113
jupyter-ai-agents explain-error \
121114
--url http://localhost:8888 \
122115
--token MY_TOKEN \
@@ -125,12 +118,6 @@ jupyter-ai-agents explain-error \
125118
--path test.ipynb
126119
```
127120

128-
You can also start request the error explanation with the following command.
129-
130-
```bash
131-
make explain-error
132-
```
133-
134121
![Jupyter AI Agents](https://assets.datalayer.tech/jupyter-ai-agent/ai-agent-explainerror-demo-terminal.gif)
135122

136123
## Uninstall

0 commit comments

Comments
 (0)