Skip to content

Commit

Permalink
Removes references to cell toolbar, mentions example notebook
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonWeill committed Apr 5, 2023
1 parent e66c801 commit d46503c
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 14 deletions.
Binary file removed docs/source/_static/codify-cell-menu.png
Binary file not shown.
Binary file removed docs/source/_static/gai-explain-code.gif
Binary file not shown.
Binary file removed docs/source/_static/jupyter-ai-toolbar.png
Binary file not shown.
4 changes: 1 addition & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

**Jupyter AI** is a package that lets Jupyter notebook users run tasks using generative AI (GAI) using APIs provided by GAI model vendors.

![Jupyter AI adds a cell toolbar button that can explain code in one click](_static/gai-explain-code.gif)

Jupyter AI provides a framework for AI modules that define GAI-powered tasks. For example, a "generate code" task uses a large language model (LLM) to generate source code from a text description, and an "explain code" task could use that same LLM to provide a plain English explanation for what some source code does. AI modules can read and write text, images, or other media formats, and can work on multiple file types — not just Jupyter notebooks. AI modules are Python packages that provide GAI interfaces and can provide JupyterLab extensions as well. They can register new models, new insertion modes, and new tasks.
Jupyter AI provides a framework for AI modules that define GAI-powered tasks. For example, a "generate code" task uses a large language model (LLM) to generate source code from a text description, and an "explain code" task could use that same LLM to provide a plain English explanation for what some source code does. AI modules can read and write text, images, or other media formats, and can work on multiple file types — not just Jupyter notebooks. AI modules are Python packages that provide GAI interfaces and can provide JupyterLab extensions as well. They can register new models, new insertion modes, and new tasks. You can use the `%%ai` magic command to start a task.

## Contents

Expand Down
14 changes: 3 additions & 11 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,19 +98,11 @@ while launching JupyterLab.
jupyter lab --ChatGptModelEngine.api_key=<api-key>
```

## Using the extension in JupyterLab
## Starting AI tasks with magic commands

In JupyterLab, once the Jupyter AI extension is installed and configured, you should see a Jupyter AI button in the cell toolbar:
The examples in this section are based on the [Jupyter AI example notebook](https://github.com/jupyterlab/jupyter-ai/blob/main/examples/magics.ipynb).

![The Jupyter AI button appears at the left of the cell toolbar](../_static/jupyter-ai-toolbar.png)

If you click the button on a markdown cell, it will run the "generate code" task, and it will create new cells with markdown and code.

If you click the button on a code cell, it will run the "explain code" tasks, and it will create a new cell with a markdown explanation of what this code does.

You can also run the "generate code" or "explain code" task by right-clicking on a cell and clicking "Codify cell with AI".

![The JupyterLab context menu includes an option to "Codify cell with AI"](../_static/codify-cell-menu.png)
The `%%ai` magic command is easy to use and gives you the most control over your calls to tasks in AI modules.

## Uninstalling

Expand Down

0 comments on commit d46503c

Please sign in to comment.