README.md 1.99 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

10
Create, run, and share self-contained large language models (LLMs). Ollama bundles a model’s weights, configuration, prompts, and more into self-contained packages that run anywhere.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
11

12
> Note: Ollama is in early preview. Please report any issues you find.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13

14
15
16
17
18
19
## Download

- [Download](https://ollama.ai/download) for macOS on Apple Silicon (Intel coming soon)
- Download for Windows and Linux (coming soon)
- Build [from source](#building)

20
## Examples
Jeffrey Morgan's avatar
Jeffrey Morgan committed
21

22
### Quickstart
23

Jeffrey Morgan's avatar
Jeffrey Morgan committed
24
```
25
26
27
ollama run llama2
>>> hi
Hello! How can I help you today?
Jeffrey Morgan's avatar
Jeffrey Morgan committed
28
29
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
30
### Creating a custom model
Jeffrey Morgan's avatar
Jeffrey Morgan committed
31

32
Create a `Modelfile`:
Jeffrey Morgan's avatar
Jeffrey Morgan committed
33

Jeffrey Morgan's avatar
Jeffrey Morgan committed
34
```
35
36
FROM llama2
PROMPT """
Jeffrey Morgan's avatar
Jeffrey Morgan committed
37
You are Mario from Super Mario Bros. Answer as Mario, the assistant, only.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
38

39
40
41
User: {{ .Prompt }}
Mario:
"""
Jeffrey Morgan's avatar
Jeffrey Morgan committed
42
```
Bruce MacDonald's avatar
Bruce MacDonald committed
43

44
Next, create and run the model:
Bruce MacDonald's avatar
Bruce MacDonald committed
45
46

```
47
48
49
50
ollama create mario -f ./Modelfile
ollama run mario
>>> hi
Hello! It's your friend Mario.
Bruce MacDonald's avatar
Bruce MacDonald committed
51
52
```

53
## Model library
Jeffrey Morgan's avatar
Jeffrey Morgan committed
54

55
Ollama includes a library of open-source, pre-trained models. More models are coming soon.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
56

57
58
59
60
61
62
63
| Model                     | Parameters | Size  | Download                    |
| ----------------------    | ---------- | ----- | --------------------------- |
| Llama2                    | 7B         | 3.8GB | `ollama pull llama2`        |
| Orca Mini                 | 3B         | 1.9GB | `ollama pull orca`          |
| Vicuna                    | 7B         | 3.8GB | `ollama pull vicuna`        |
| Nous-Hermes               | 13B        | 7.3GB | `ollama pull nous-hermes`   |
| Wizard Vicuna Uncensored  | 13B        | 6.8GB | `ollama pull wizard-vicuna` |
Jeffrey Morgan's avatar
Jeffrey Morgan committed
64

Jeffrey Morgan's avatar
Jeffrey Morgan committed
65
66
67
## Building

```
Michael Yang's avatar
Michael Yang committed
68
go build .
Jeffrey Morgan's avatar
Jeffrey Morgan committed
69
70
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
71
To run it start the server:
Bruce MacDonald's avatar
Bruce MacDonald committed
72

Jeffrey Morgan's avatar
Jeffrey Morgan committed
73
74
75
76
77
78
79
```
./ollama server &
```

Finally, run a model!

```
80
./ollama run llama2
Jeffrey Morgan's avatar
Jeffrey Morgan committed
81
```