Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 4.26 KB

README.md

File metadata and controls

112 lines (73 loc) · 4.26 KB
Raw

jupyterlab-codestral

Github Actions Status lite-badge

AI code completions and chat for JupyterLab, Notebook 7 and JupyterLite, powered by MistralAI ✨

jupyterlab-codestral-demo-lite.webm

Requirements

Note

This extension is meant to be used in JupyterLite to enable AI code completions and chat in the browser, with a specific provider. To enable more AI providers in JupyterLab and Jupyter Notebook, we recommend using the Jupyter AI extension directly. At the moment Jupyter AI is not compatible with JupyterLite, but might be to some extent in the future.

  • JupyterLab >= 4.1.0 or Notebook >= 7.1.0

Warning

This extension is still very much experimental. It is not an official MistralAI extension. It is exploring the integration of the MistralAI API with JupyterLab, which can also be used in JupyterLite. For a more complete AI extension for JupyterLab, see Jupyter AI.

✨ Try it in your browser ✨

You can try the extension in your browser using JupyterLite:

lite-badge

See the Usage section below for more information on how to provide your API key.

Install

To install the extension, execute:

pip install jupyterlab-codestral

Usage

  1. Go to https://console.mistral.ai/api-keys/ and create an API key.

Screenshot showing how to create an API key

  1. Open the JupyterLab settings and go to the Codestral section to enter the API key

Screenshot showing how to add the API key to the settings

  1. Open the chat, or use the inline completer

Screenshot showing how to use the chat

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-codestral

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_codestral directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall jupyterlab-codestral

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlab-codestral within that folder.

Packaging the extension

See RELEASE