Go to file
Jeffrey Morgan 485016bfbb
Update install.sh
2024-05-26 11:46:00 -07:00
.github set codesign timeout to longer (#4605) 2024-05-23 22:46:23 -07:00
api Ollama `ps` command for showing currently loaded models (#4327) 2024-05-13 17:17:36 -07:00
app Move envconfig and consolidate env vars (#4608) 2024-05-24 14:57:15 -07:00
auth prompt to display and add local ollama keys to account (#3717) 2024-04-30 11:02:08 -07:00
cmd Move envconfig and consolidate env vars (#4608) 2024-05-24 14:57:15 -07:00
convert chore: update tokenizer.go (#4571) 2024-05-22 00:25:23 -07:00
docs Tidy up developer guide a little 2024-05-23 15:14:05 -07:00
envconfig Move envconfig and consolidate env vars (#4608) 2024-05-24 14:57:15 -07:00
examples remove `bash-comparemodels` example 2024-05-08 19:49:45 -07:00
format Ollama `ps` command for showing currently loaded models (#4327) 2024-05-13 17:17:36 -07:00
gpu Move envconfig and consolidate env vars (#4608) 2024-05-24 14:57:15 -07:00
integration Skip max queue test on remote 2024-05-16 16:24:18 -07:00
llm Merge pull request #4638 from dhiltgen/better_error 2024-05-25 14:32:28 -07:00
macapp updated updateURL 2024-05-20 15:24:32 -07:00
openai Fix OpenAI `finish_reason` values when empty (#4368) 2024-05-11 15:31:41 -07:00
parser Move the parser back + handle utf16 files (#4533) 2024-05-20 11:26:45 -07:00
progress change `github.com/jmorganca/ollama` to `github.com/ollama/ollama` (#3347) 2024-03-26 13:04:17 -07:00
readline Fix paste of text with line feed characters (#3043) 2024-05-07 15:26:07 -07:00
scripts Update install.sh 2024-05-26 11:46:00 -07:00
server Merge pull request #4619 from noxer/patch-1 2024-05-24 17:21:57 -07:00
types Move the parser back + handle utf16 files (#4533) 2024-05-20 11:26:45 -07:00
version add version 2023-08-22 09:40:58 -07:00
.dockerignore add `macapp` to `.dockerignore` 2024-03-09 16:07:06 -08:00
.gitattributes Update .gitattributes 2024-05-07 09:50:19 -07:00
.gitignore ignore debug bin files 2024-05-01 18:51:10 +00:00
.gitmodules Init submodule with new path 2024-01-04 13:00:13 -08:00
.golangci.yaml Revert "fix golangci workflow missing gofmt and goimports (#4190)" 2024-05-07 10:35:44 -07:00
.prettierrc.json move .prettierrc.json to root 2023-07-02 17:34:46 -04:00
Dockerfile rearranged conditional logic for static build, dockerfile updated 2024-04-17 14:43:28 -04:00
LICENSE `proto` -> `ollama` 2023-06-26 15:57:13 -04:00
README.md Tidy up developer guide a little 2024-05-23 15:14:05 -07:00
go.mod simplify safetensors reading 2024-05-21 11:28:22 -07:00
go.sum simplify safetensors reading 2024-05-21 11:28:22 -07:00
main.go change `github.com/jmorganca/ollama` to `github.com/ollama/ollama` (#3347) 2024-03-26 13:04:17 -07:00

README.md

 ollama

Ollama

Discord

Get up and running with large language models locally.

macOS

Download

Windows preview

Download

Linux

curl -fsSL https://ollama.com/install.sh | sh

Manual install instructions

Docker

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

Libraries

Quickstart

To run and chat with Llama 3:

ollama run llama3

Model library

Ollama supports a list of models available on ollama.com/library

Here are some example models that can be downloaded:

Model Parameters Size Download
Llama 3 8B 4.7GB ollama run llama3
Llama 3 70B 40GB ollama run llama3:70b
Phi 3 Mini 3.8B 2.3GB ollama run phi3
Phi 3 Medium 14B 7.9GB ollama run phi3:medium
Gemma 2B 1.4GB ollama run gemma:2b
Gemma 7B 4.8GB ollama run gemma:7b
Mistral 7B 4.1GB ollama run mistral
Moondream 2 1.4B 829MB ollama run moondream
Neural Chat 7B 4.1GB ollama run neural-chat
Starling 7B 4.1GB ollama run starling-lm
Code Llama 7B 3.8GB ollama run codellama
Llama 2 Uncensored 7B 3.8GB ollama run llama2-uncensored
LLaVA 7B 4.5GB ollama run llava
Solar 10.7B 6.1GB ollama run solar

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

Customize a 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 llama3 model:

ollama pull llama3

Create a Modelfile:

FROM llama3

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

# set the system message
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.

ollama create mymodel -f ./Modelfile

Pull a model

ollama pull llama3

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

Remove a model

ollama rm llama3

Copy a model

ollama cp llama3 my-model

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.

Multimodal models

>>> What's in this image? /Users/jmorgan/Desktop/smile.png
The image features a yellow smiley face, which is likely the central focus of the picture.

Pass the prompt as an argument

$ ollama run llama3 "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

See the developer guide

Running local builds

Next, start the server:

./ollama serve

Finally, in a separate shell, run a model:

./ollama run llama3

REST API

Ollama has a REST API for running and managing models.

Generate a response

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

Chat with a model

curl http://localhost:11434/api/chat -d '{
  "model": "llama3",
  "messages": [
    { "role": "user", "content": "why is the sky blue?" }
  ]
}'

See the API documentation for all endpoints.

Community Integrations

Web & Desktop

Terminal

Database

Package managers

Libraries

Mobile

Extensions & Plugins

Supported backends

  • llama.cpp project founded by Georgi Gerganov.