README.md 750 Bytes
Newer Older
Bruce MacDonald's avatar
Bruce MacDonald committed
1
# Ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
2

Jeffrey Morgan's avatar
Jeffrey Morgan committed
3
A fast runtime for large language models, powered by [llama.cpp](https://github.com/ggerganov/llama.cpp).
Jeffrey Morgan's avatar
Jeffrey Morgan committed
4

Jeffrey Morgan's avatar
Jeffrey Morgan committed
5
> _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._
Jeffrey Morgan's avatar
Jeffrey Morgan committed
6
7

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

9
10
Using `pip`:

Jeffrey Morgan's avatar
Jeffrey Morgan committed
11
```
Bruce MacDonald's avatar
Bruce MacDonald committed
12
pip install ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13
14
```

15
16
Using `docker`:

Jeffrey Morgan's avatar
Jeffrey Morgan committed
17
18
19
20
```
docker run ollama/ollama
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
21
## Quickstart
Jeffrey Morgan's avatar
Jeffrey Morgan committed
22

Jeffrey Morgan's avatar
Jeffrey Morgan committed
23
24
25
26
To run a model, use `ollama run`:

```
ollama run orca-mini-3b
Jeffrey Morgan's avatar
Jeffrey Morgan committed
27
28
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
29
You can also run models from hugging face:
Bruce MacDonald's avatar
Bruce MacDonald committed
30

Jeffrey Morgan's avatar
Jeffrey Morgan committed
31
32
33
```
ollama run huggingface.co/TheBloke/orca_mini_3B-GGML
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
34

Jeffrey Morgan's avatar
Jeffrey Morgan committed
35
36
37
38
Or directly via downloaded model files:

```
ollama run ~/Downloads/orca-mini-13b.ggmlv3.q4_0.bin
Jeffrey Morgan's avatar
Jeffrey Morgan committed
39
40
```

Bruce MacDonald's avatar
Bruce MacDonald committed
41
42
43
## Documentation

- [Development](docs/development.md)
44
- [Python SDK](docs/python.md)