Skip to content
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

Jump to bottom

Update docs for ai features #2201

Merged
merged 2 commits into from
Sep 3, 2024
Merged

Update docs for ai features #2201

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63823a5
Update docs for ai features
akshayka Sep 3, 2024
73da8d1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 3, 2024
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
35 changes: 21 additions & 14 deletions docs/guides/editor_features/ai_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,25 @@ copilot = "codeium"
codeium_api_key = ""
```

## Using AI to modify cells
## Generate code with our AI assistant

This feature is currently experimental and is not enabled by default. To enable it:
marimo has built-in support for generating and refactoring code with AI, with a
variety of providers. marimo works with both hosted AI providers, such as
OpenAI and Anthropic, as well as local models served via Ollama.

Below we describe how to connect marimo to your AI provider. Once enabled, you
can generate entirely new cells by clicking the "Generate with AI" button at
the bottom of your notebook. You can also refactor existing cells by inputting
`Ctrl/Cmd-Shift-e` in a cell, opening an input to modify the cell using AI.

<div align="center">
<figure>
<video src="/_static/ai-completion.mp4" controls="controls" width="100%" height="100%"></video>
<figcaption>Use AI to modify a cell by pressing `Ctrl/Cmd-Shift-e`.</figcaption>
</figure>
</div>

### Using OpenAI

1. Install openai: `pip install openai`

Expand All @@ -53,16 +69,6 @@ model = "gpt-4-turbo"
base_url = "https://api.openai.com/v1"
```

Once enabled, you can use AI completion by pressing `Ctrl/Cmd-Shift-e` in a
cell. This will open an input to modify the cell using AI.

<div align="center">
<figure>
<video src="/_static/ai-completion.mp4" controls="controls" width="100%" height="100%"></video>
<figcaption>Use AI to modify a cell by pressing `Ctrl/Cmd-Shift-e`.</figcaption>
</figure>
</div>

### Using Anthropic

To use Anthropic with marimo:
Expand All @@ -85,9 +91,10 @@ marimo supports OpenAI's GPT-3.5 API by default. If your provider is compatible

For other providers not compatible with OpenAI's API, please submit a [feature request](https://github.com/marimo-team/marimo/issues) or "thumbs up" an existing one.

### Using Ollama
### Using local models with Ollama

Ollama allows you to run open-source LLMs (e.g. Llama 3.1, Phi 3, Mistral, Gemma 2) on your local machine. To integrate Ollama with marimo:
Ollama allows you to run open-source LLMs (e.g. Llama 3.1, Phi 3, Mistral,
Gemma 2) on your local machine. To integrate Ollama with marimo:

1. Download and install [Ollama](https://ollama.com/).
2. Download the model you want to use:
Expand Down
Loading