diff --git a/docs/source/_static/chat-ask-command.png b/docs/source/_static/chat-ask-command.png index 48ee7dd89..7ae3c0e7f 100644 Binary files a/docs/source/_static/chat-ask-command.png and b/docs/source/_static/chat-ask-command.png differ diff --git a/docs/source/_static/chat-generate-command-response.png b/docs/source/_static/chat-generate-command-response.png index 45ab63f34..418c8676b 100644 Binary files a/docs/source/_static/chat-generate-command-response.png and b/docs/source/_static/chat-generate-command-response.png differ diff --git a/docs/source/_static/chat-generate-file.png b/docs/source/_static/chat-generate-file.png index 70d7796b2..9be9b0bd0 100644 Binary files a/docs/source/_static/chat-generate-file.png and b/docs/source/_static/chat-generate-file.png differ diff --git a/docs/source/_static/chat-generate-input.png b/docs/source/_static/chat-generate-input.png index d9547512e..4f6d571e5 100644 Binary files a/docs/source/_static/chat-generate-input.png and b/docs/source/_static/chat-generate-input.png differ diff --git a/docs/source/_static/chat-learn-delete.png b/docs/source/_static/chat-learn-delete.png index 0ec5a7462..3889cd7ad 100644 Binary files a/docs/source/_static/chat-learn-delete.png and b/docs/source/_static/chat-learn-delete.png differ diff --git a/docs/source/_static/chat-learn-docs.png b/docs/source/_static/chat-learn-docs.png index 74f5a70c5..942313b22 100644 Binary files a/docs/source/_static/chat-learn-docs.png and b/docs/source/_static/chat-learn-docs.png differ diff --git a/docs/source/users/index.md b/docs/source/users/index.md index 232c427cb..ec0b6e259 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -177,17 +177,23 @@ you run it. After Jupyter AI sends a response, your notebook will be updated immediately with the response replacing the selection. You can also see the response in the chat panel. -![Screen shot of Jupyter AI displaying a response in the chat panel and in the notebook.](../_static/chat-replace-selection-output.png) +Screen shot of Jupyter AI displaying a response in the chat panel and in the notebook. ### Generating a new notebook You can use Jupyter AI to generate an entire notebook from a text prompt. To get started, open the chat panel, and send it a message starting with `/generate`. -![Screen shot of a prompt reading "/generate A demonstration of how to use Matplotlib" in Jupyter AI](../_static/chat-generate-input.png) +Screen shot of a prompt reading "/generate A demonstration of how to use Matplotlib" in Jupyter AI Generating a notebook can take a substantial amount of time, so Jupyter AI will respond to your message immediately while it works. You can continue to ask it other questions in the meantime. -![Screen shot of Jupyter AI responding to a generate message with a message that it is working on a notebook.](../_static/chat-generate-command-response.png) +Screen shot of Jupyter AI responding to a generate message with a message that it is working on a notebook. :::{note} :name: generate-progress @@ -199,7 +205,9 @@ Jupyter AI is working. When Jupyter AI is done generating your notebook, it will send you another message with the filename that it generated. -![Screen shot of Jupyter AI response indicating the file name that it wrote.](../_static/chat-generate-file.png) +Screen shot of Jupyter AI response indicating the file name that it wrote. You can then open this file using the file browser. @@ -210,7 +218,9 @@ you run the code contained in them. Please review all generated code carefully before you run it. ::: -![Screen shot of generated notebook built using Jupyter AI](../_static/chat-generate-notebook-opened.png) +Screen shot of generated notebook built using Jupyter AI ### Learning about local data @@ -218,15 +228,21 @@ Using the `/learn` command, you can teach Jupyter AI about local data so that it To teach Jupyter AI about a folder full of documentation, for example, run `/learn docs/`. You will receive a response when Jupyter AI has indexed this documentation in a local vector database. -![Screen shot of "/learn docs/" command and a response.](../_static/chat-learn-docs.png) +Screen shot of "/learn docs/" command and a response. You can then use `/ask` to ask a question specifically about the data that you taught Jupyter AI with `/learn`. -![Screen shot of an "/ask" command and a response.](../_static/chat-ask-command.png) +Screen shot of an "/ask" command and a response. To clear the local vector database, you can run `/learn -d` and Jupyter AI will forget all information that it learned from your `/learn` commands. -![Screen shot of a "/learn -d" command and a response.](../_static/chat-learn-delete.png) +Screen shot of a "/learn -d" command and a response. ### Additional chat commands