No description
Find a file
Daniel Hiltgen afa61bdf45
Merge pull request #1075 from jmorganca/dhiltgen/unexpected-eof
Resume chunk download on UnexpectedEOF errors
2023-11-10 08:48:27 -08:00
api JSON mode: add `"format" as an api parameter (#1051) 2023-11-09 16:44:02 -08:00
app update dependencies in app/ 2023-10-19 15:52:41 -04:00
cmd fix tautology 2023-10-31 20:49:48 -07:00
docs JSON mode: add `"format" as an api parameter (#1051) 2023-11-09 16:44:02 -08:00
examples Merge pull request #955 from jmorganca/mattw/example-bash-compare 2023-11-10 08:59:32 -06:00
format instead of static number of parameters for each model family, get the real number from the tensors (#1022) 2023-11-08 17:55:46 -08:00
llm JSON mode: add `"format" as an api parameter (#1051) 2023-11-09 16:44:02 -08:00
parser deprecate modelfile embed command (#759) 2023-10-16 11:07:37 -04:00
progressbar progressbar: make start and end seamless (#1042) 2023-11-08 16:42:40 -08:00
readline go fmt 2023-11-01 11:55:08 -07:00
scripts Fix sudo variable in install.sh (#1034) 2023-11-07 09:59:57 -08:00
server Resume chunk download on UnexpectedEOF errors 2023-11-10 08:29:42 -08:00
version add version 2023-08-22 09:40:58 -07:00
.dockerignore add .env to .dockerignore 2023-09-23 00:53:48 -04:00
.gitignore update docs for subprocess 2023-08-30 17:54:02 -04:00
.gitmodules silence warm up log 2023-09-21 14:53:33 -07:00
.prettierrc.json move .prettierrc.json to root 2023-07-02 17:34:46 -04:00
Dockerfile use Go 1.21.3 in Dockerfile 2023-10-12 23:23:12 -04:00
Dockerfile.build use lower glibc versions in Dockerfile.build 2023-10-13 01:06:19 -04:00
go.mod go mod tidy 2023-11-01 11:54:25 -07:00
go.sum go mod tidy 2023-11-01 11:54:25 -07:00
LICENSE proto -> ollama 2023-06-26 15:57:13 -04:00
main.go set non-zero error code on error 2023-08-14 14:09:58 -07:00
README.md Update README.md 2023-11-09 12:53:24 -08:00

logo

Ollama

Discord

Get up and running with large language models locally.

macOS

Download

Windows

Coming soon!

Linux & WSL2

curl https://ollama.ai/install.sh | sh

Manual install instructions

Docker

The official Ollama Docker image ollama/ollama is available on Docker Hub.

Quickstart

To run and chat with Llama 2:

ollama run llama2

Model library

Ollama supports a list of open-source models available on ollama.ai/library

Here are some example open-source models that can be downloaded:

Model Parameters Size Download
Mistral 7B 4.1GB ollama run mistral
Llama 2 7B 3.8GB ollama run llama2
Code Llama 7B 3.8GB ollama run codellama
Llama 2 Uncensored 7B 3.8GB ollama run llama2-uncensored
Llama 2 13B 13B 7.3GB ollama run llama2:13b
Llama 2 70B 70B 39GB ollama run llama2:70b
Orca Mini 3B 1.9GB ollama run orca-mini
Vicuna 7B 3.8GB ollama run vicuna

Note: You should have at least 8 GB of RAM to run the 3B models, 16 GB to run the 7B models, and 32 GB to run the 13B models.

Customize your own model

Import from GGUF

Ollama supports importing GGUF models in the Modelfile:

  1. Create a file named Modelfile, with a FROM instruction with the local filepath to the model you want to import.

    FROM ./vicuna-33b.Q4_0.gguf
    
  2. Create the model in Ollama

    ollama create example -f Modelfile
    
  3. Run the model

    ollama run example
    

Import from PyTorch or Safetensors

See the guide on importing models for more information.

Customize a prompt

Models from the Ollama library can be customized with a prompt. For example, to customize the llama2 model:

ollama pull llama2

Create a Modelfile:

FROM llama2

# set the temperature to 1 [higher is more creative, lower is more coherent]
PARAMETER temperature 1

# set the system prompt
SYSTEM """
You are Mario from Super Mario Bros. Answer as Mario, the assistant, only.
"""

Next, create and run the model:

ollama create mario -f ./Modelfile
ollama run mario
>>> hi
Hello! It's your friend Mario.

For more examples, see the examples directory. For more information on working with a Modelfile, see the Modelfile documentation.

CLI Reference

Create a model

ollama create is used to create a model from a Modelfile.

Pull a model

ollama pull llama2

This command can also be used to update a local model. Only the diff will be pulled.

Remove a model

ollama rm llama2

Copy a model

ollama cp llama2 my-llama2

Multiline input

For multiline input, you can wrap text with """:

>>> """Hello,
... world!
... """
I'm a basic program that prints the famous "Hello, world!" message to the console.

Pass in prompt as arguments

$ ollama run llama2 "Summarize this file: $(cat README.md)"
 Ollama is a lightweight, extensible framework for building and running language models on the local machine. It provides a simple API for creating, running, and managing models, as well as a library of pre-built models that can be easily used in a variety of applications.

List models on your computer

ollama list

Start Ollama

ollama serve is used when you want to start ollama without running the desktop application.

Building

Install cmake and go:

brew install cmake go

Then generate dependencies and build:

go generate ./...
go build .

Next, start the server:

./ollama serve

Finally, in a separate shell, run a model:

./ollama run llama2

REST API

Ollama has a REST API for running and managing models. For example, to generate text from a model:

curl -X POST http://localhost:11434/api/generate -d '{
  "model": "llama2",
  "prompt":"Why is the sky blue?"
}'

See the API documentation for all endpoints.

Community Integrations

Web & Desktop

Terminal

Libraries

Extensions & Plugins