README.md 2.12 KB
Newer Older
Michael Chiang's avatar
Michael Chiang committed
1
2
3
4
5
6
<div align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" height="200px" srcset="https://github.com/jmorganca/ollama/assets/3325447/318048d2-b2dd-459c-925a-ac8449d5f02c">
    <img alt="logo" height="200px" src="https://github.com/jmorganca/ollama/assets/3325447/c7d6e15f-7f4d-4776-b568-c084afa297c2">
  </picture>
</div>
Jeffrey Morgan's avatar
Jeffrey Morgan committed
7

Bruce MacDonald's avatar
Bruce MacDonald committed
8
# Ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
9

Jeffrey Morgan's avatar
Jeffrey Morgan committed
10
11
Run large language models with `llama.cpp`.

Jeffrey Morgan's avatar
Jeffrey Morgan committed
12
> Note: certain models that can be run with Ollama are intended for research and/or non-commercial use only.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13
14

### Features
Jeffrey Morgan's avatar
Jeffrey Morgan committed
15

Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
17
18
- Download and run popular large language models
- Switch between multiple models on the fly
- Hardware acceleration where available (Metal, CUDA)
Jeffrey Morgan's avatar
Go  
Jeffrey Morgan committed
19
- Fast inference server written in Go, powered by [llama.cpp](https://github.com/ggerganov/llama.cpp)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
20
- REST API to use with your application (python, typescript SDKs coming soon)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
21
22

## Install
Jeffrey Morgan's avatar
Jeffrey Morgan committed
23

24
- [Download](https://ollama.ai/download) for macOS with Apple Silicon (Intel coming soon)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
25
26
27
28
29
30
- Download for Windows (coming soon)

You can also build the [binary from source](#building).

## Quickstart

Bruce MacDonald's avatar
Bruce MacDonald committed
31
Run a fast and simple model.
32

Jeffrey Morgan's avatar
Jeffrey Morgan committed
33
```
Bruce MacDonald's avatar
Bruce MacDonald committed
34
ollama run orca
Jeffrey Morgan's avatar
Jeffrey Morgan committed
35
36
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
37
38
39
40
41
## Example models

### 💬 Chat

Have a conversation.
42

Jeffrey Morgan's avatar
Jeffrey Morgan committed
43
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
44
ollama run vicuna "Why is the sky blue?"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
45
46
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
47
### 🗺️ Instructions
Jeffrey Morgan's avatar
Jeffrey Morgan committed
48

49
Get a helping hand.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
50
51

```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
52
ollama run orca "Write an email to my boss."
Jeffrey Morgan's avatar
Jeffrey Morgan committed
53
54
```

Bruce MacDonald's avatar
Bruce MacDonald committed
55
56
57
58
59
60
61
62
### 🔎 Ask questions about documents

Send the contents of a document and ask questions about it.

```
ollama run nous-hermes "$(cat input.txt)", please summarize this story
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
63
64
65
### 📖 Storytelling

Venture into the unknown.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
66
67

```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
68
69
70
71
72
73
74
75
76
ollama run nous-hermes "Once upon a time"
```

## Advanced usage

### Run a local model

```
ollama run ~/Downloads/vicuna-7b-v1.3.ggmlv3.q4_1.bin
Jeffrey Morgan's avatar
Jeffrey Morgan committed
77
78
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
79
80
81
## Building

```
Michael Yang's avatar
Michael Yang committed
82
go build .
Jeffrey Morgan's avatar
Jeffrey Morgan committed
83
84
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
85
To run it start the server:
Bruce MacDonald's avatar
Bruce MacDonald committed
86

Jeffrey Morgan's avatar
Jeffrey Morgan committed
87
88
89
90
91
92
93
94
95
96
97
98
```
./ollama server &
```

Finally, run a model!

```
./ollama run ~/Downloads/vicuna-7b-v1.3.ggmlv3.q4_1.bin
```

## API Reference

Jeffrey Morgan's avatar
Jeffrey Morgan committed
99
100
101
102
103
104
105
106
107
### `POST /api/pull`

Download a model

```
curl -X POST http://localhost:11343/api/pull -d '{"model": "orca"}'
```

### `POST /api/generate`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
108
109
110
111

Complete a prompt

```
112
curl -X POST http://localhost:11434/api/generate -d '{"model": "orca", "prompt": "hello!"}'
Jeffrey Morgan's avatar
Jeffrey Morgan committed
113
```