Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed Aug 19, 2024
1 parent 2db2e33 commit b3299db
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,29 @@ We currently support the following language model providers:
- `openai-chat`
- `sagemaker-endpoint`

### Configuring a default model

To configure a default model you can use the IPython `%config` magic:

```python
%config AiMagics.default_language_model = "anthropic:claude-v1.2"
```

Then subsequent magics can be invoked without typing in the model:

```
%%ai
Write a poem about C++.
```

You can configure the default model for all notebooks by specifying `c.AiMagics.default_language_model` tratilet in `ipython_config.py`, for example:

```python
c.AiMagics.default_language_model = "anthropic:claude-v1.2"
```

The location of `ipython_config.py` file is documented in [IPython configuration reference](https://ipython.readthedocs.io/en/stable/config/intro.html).

### Listing available models

Jupyter AI also includes multiple subcommands, which may be invoked via the
Expand Down

0 comments on commit b3299db

Please sign in to comment.