From 0dbcc871de682eb89f176b16f30fea52c7be18aa Mon Sep 17 00:00:00 2001
From: Jeremy Tuloup <jeremy.tuloup@gmail.com>
Date: Wed, 10 Jul 2024 11:08:34 +0200
Subject: [PATCH] Mention Ollama in the docs

---
 README.md                  |  2 +-
 docs/source/users/index.md | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 41be45c6b..682c4bf23 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ in JupyterLab and the Jupyter Notebook. More specifically, Jupyter AI offers:
 * A native chat UI in JupyterLab that enables you to work with generative AI as a conversational assistant.
 * Support for a wide range of generative model providers, including AI21, Anthropic, AWS, Cohere,
   Gemini, Hugging Face, MistralAI, NVIDIA, and OpenAI.
-* Local model support through GPT4All, enabling use of generative AI models on consumer grade machines
+* Local model support through GPT4All and Ollama, enabling use of generative AI models on consumer grade machines
   with ease and privacy.
 
 Documentation is available on [ReadTheDocs](https://jupyter-ai.readthedocs.io/en/latest/).
diff --git a/docs/source/users/index.md b/docs/source/users/index.md
index 8db821238..99388328a 100644
--- a/docs/source/users/index.md
+++ b/docs/source/users/index.md
@@ -357,6 +357,28 @@ GPT4All support is still an early-stage feature, so some bugs may be encountered
 during usage. Our team is still actively improving support for locally-hosted
 models.
 
+### Ollama usage (early-stage)
+
+Jupyter AI provides basic support for Ollama models.
+
+To get started, follow the instructions on the [Ollama website](https://ollama.com/) to set up `ollama` and download the models locally. Currently Jupyter AI only supports the following models:
+
+- `gemma`
+- `gemma2`
+- `llama2`,
+- `llama3`,
+- `llama3:70b`,
+- `phi3`,
+- `mistral`,
+- `tinyllama`,
+- `qwen2`,
+- `qwen2:7b`,
+- `qwen2:72b`,
+
+:::{note}
+There are plans to make the list of Ollama models configurable in the future, so users can download more models available via Ollama.
+:::
+
 ### Asking about something in your notebook
 
 Jupyter AI's chat interface can include a portion of your notebook in your prompt.