Get up and running with OpenAI gpt-oss, DeepSeek-R1, Gemma 3 and other models.
Go to file
Jeffrey Morgan bbc05f957f add `docker` instruction 2023-06-30 12:31:00 -04:00
desktop update `README.md` with instructions for `poetry` 2023-06-28 11:47:37 -04:00
docs update development.md 2023-06-28 12:41:30 -07:00
ollama add help and descriptions to cli 2023-06-30 12:14:59 -04:00
.gitignore add templates to prompt command 2023-06-26 13:41:16 -04:00
Dockerfile add basic `Dockerfile` 2023-06-30 12:19:04 -04:00
LICENSE `proto` -> `ollama` 2023-06-26 15:57:13 -04:00
README.md add `docker` instruction 2023-06-30 12:31:00 -04:00
build.py desktop: fixes for initial publish 2023-06-27 14:34:56 -04:00
models.json use correct name for `orca-mini` 2023-06-29 18:16:33 -04:00
poetry.lock spinner on generate 2023-06-29 16:42:43 -04:00
pyproject.toml bump to 0.0.6 2023-06-29 19:22:20 -04:00
requirements.txt remove server extras for now 2023-06-28 17:59:23 -07:00

README.md

Ollama

Ollama is a tool for running any large language model on any machine. It's designed to be easy to use and fast, supporting the largest number of models possible by using the fastest loader available for your platform and model.

Note: this project is a work in progress. Certain models that can be run with ollama are intended for research and/or non-commercial use only.

Install

pip install ollama
docker run ollama/ollama

Quickstart

To run a model, use ollama run:

ollama run orca-mini-3b

You can also run models from hugging face:

ollama run huggingface.co/TheBloke/orca_mini_3B-GGML

Or directly via downloaded model files:

ollama run ~/Downloads/orca-mini-13b.ggmlv3.q4_0.bin

Python SDK

Example

import ollama
ollama.generate("orca-mini-3b", "hi")

ollama.generate(model, message)

Generate a completion

ollama.generate("./llama-7b-ggml.bin", "hi")

ollama.models()

List available local models

models = ollama.models()

ollama.load(model)

Manually a model for generation

ollama.load("model")

ollama.unload(model)

Unload a model

ollama.unload("model")

ollama.pull(model)

Download a model

ollama.pull("huggingface.co/thebloke/llama-7b-ggml")

Coming Soon

ollama.search("query")

Search for compatible models that Ollama can run

ollama.search("llama-7b")

Documentation