README.md 1.23 KB
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
- Run models easily
Bruce MacDonald's avatar
Bruce MacDonald committed
4
- Download, manage and import models
Jeffrey Morgan's avatar
Jeffrey Morgan committed
5

Bruce MacDonald's avatar
Bruce MacDonald committed
6
## Install
Jeffrey Morgan's avatar
Jeffrey Morgan committed
7
8

```
Bruce MacDonald's avatar
Bruce MacDonald committed
9
pip install ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
10
11
```

Bruce MacDonald's avatar
Bruce MacDonald committed
12
## Example quickstart
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13

Bruce MacDonald's avatar
Bruce MacDonald committed
14
15
```python
import ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
ollama.generate("./llama-7b-ggml.bin", "hi")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
17
18
```

Bruce MacDonald's avatar
Bruce MacDonald committed
19
## Reference
Jeffrey Morgan's avatar
Jeffrey Morgan committed
20

Jeffrey Morgan's avatar
Jeffrey Morgan committed
21
### `ollama.generate(model, message)`
Bruce MacDonald's avatar
Bruce MacDonald committed
22

Jeffrey Morgan's avatar
Jeffrey Morgan committed
23
Generate a completion
Bruce MacDonald's avatar
Bruce MacDonald committed
24
25

```python
Jeffrey Morgan's avatar
Jeffrey Morgan committed
26
ollama.generate("./llama-7b-ggml.bin", "hi")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
27
28
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
29
### `ollama.load(model)`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
30

Jeffrey Morgan's avatar
Jeffrey Morgan committed
31
Load a model for generation
Jeffrey Morgan's avatar
Jeffrey Morgan committed
32

Bruce MacDonald's avatar
Bruce MacDonald committed
33
```python
Jeffrey Morgan's avatar
Jeffrey Morgan committed
34
ollama.load("model")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
35
36
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
37
### `ollama.models()`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
38

Jeffrey Morgan's avatar
Jeffrey Morgan committed
39
List available local models
Bruce MacDonald's avatar
Bruce MacDonald committed
40
41
42

```
models = ollama.models()
Jeffrey Morgan's avatar
Jeffrey Morgan committed
43
44
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
45
### `ollama.serve()`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
46

Bruce MacDonald's avatar
Bruce MacDonald committed
47
Serve the ollama http server
Jeffrey Morgan's avatar
Jeffrey Morgan committed
48

Jeffrey Morgan's avatar
Jeffrey Morgan committed
49
## Cooming Soon
Jeffrey Morgan's avatar
Jeffrey Morgan committed
50

Jeffrey Morgan's avatar
Jeffrey Morgan committed
51
### `ollama.pull(model)`
Bruce MacDonald's avatar
Bruce MacDonald committed
52

Jeffrey Morgan's avatar
Jeffrey Morgan committed
53
Download a model
Bruce MacDonald's avatar
Bruce MacDonald committed
54
55
56

```python
ollama.pull("huggingface.co/thebloke/llama-7b-ggml")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
57
58
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
59
### `ollama.import(filename)`
Bruce MacDonald's avatar
Bruce MacDonald committed
60

Jeffrey Morgan's avatar
Jeffrey Morgan committed
61
Import a model from a file
Bruce MacDonald's avatar
Bruce MacDonald committed
62
63
64
65

```python
ollama.import("./path/to/model")
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
66

Jeffrey Morgan's avatar
Jeffrey Morgan committed
67
### `ollama.search("query")`
68

Bruce MacDonald's avatar
Bruce MacDonald committed
69
Search for compatible models that Ollama can run
70

Bruce MacDonald's avatar
Bruce MacDonald committed
71
72
73
```python
ollama.search("llama-7b")
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
74

Bruce MacDonald's avatar
Bruce MacDonald committed
75
## Future CLI
76

Jeffrey Morgan's avatar
Jeffrey Morgan committed
77
In the future, there will be an `ollama` CLI for running models on servers, in containers or for local development environments.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
78

Bruce MacDonald's avatar
Bruce MacDonald committed
79
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
80
ollama generate huggingface.co/thebloke/llama-7b-ggml "hi"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
81
> Downloading [================>          ] 66.67% (2/3) 30.2MB/s
Bruce MacDonald's avatar
Bruce MacDonald committed
82
```
Bruce MacDonald's avatar
Bruce MacDonald committed
83
84
85
86

## Documentation

- [Development](docs/development.md)