Skip to content

Commit 2d040f4

Browse files
authored
Merge pull request #26 from jtpio/readme-edits
Update README.md
2 parents 3bb6c5b + 757dfe9 commit 2d040f4

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Github Actions Status](https://github.com/jupyterlite/ai/workflows/Build/badge.svg)](https://github.com/jupyterlite/ai/actions/workflows/build.yml)
44
[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/ai/lab/index.html)
55

6-
AI code completions and chat for JupyterLab, Notebook 7 and JupyterLite, powered by MistralAI
6+
AI code completions and chat for JupyterLab, Notebook 7 and JupyterLite ✨
77

88
[a screencast showing the Jupyterlite AI extension in JupyterLite](https://github.com/jupyterlite/ai/assets/591645/855c4e3e-3a63-4868-8052-5c9909922c21)
99

@@ -16,11 +16,6 @@ AI code completions and chat for JupyterLab, Notebook 7 and JupyterLite, powered
1616
1717
- JupyterLab >= 4.4.0a0 or Notebook >= 7.4.0a0
1818

19-
> [!WARNING]
20-
> This extension is still very much experimental. It is not an official MistralAI extension.
21-
> It is exploring the integration of the MistralAI API with JupyterLab, which can also be used in [JupyterLite](https://jupyterlite.readthedocs.io/).
22-
> For a more complete AI extension for JupyterLab, see [Jupyter AI](https://github.com/jupyterlab/jupyter-ai).
23-
2419
## ✨ Try it in your browser ✨
2520

2621
You can try the extension in your browser using JupyterLite:
@@ -45,6 +40,15 @@ pip install jupyterlite-ai[jupyter]
4540

4641
# Usage
4742

43+
AI providers typically require using an API key to access their models.
44+
45+
The process is different for each provider, so you may refer to their documentation to learn how to generate new API keys, if they are not covered in the sections below.
46+
47+
## Using MistralAI
48+
49+
> [!WARNING]
50+
> This extension is still very much experimental. It is not an official MistralAI extension.
51+
4852
1. Go to https://console.mistral.ai/api-keys/ and create an API key.
4953

5054
![Screenshot showing how to create an API key](./img/1-api-key.png)

img/2-jupyterlab-settings.png

30.1 KB
Loading

0 commit comments

Comments
 (0)