README.md 1.36 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
The easiest way to run ai models.
Jeffrey Morgan's avatar
Jeffrey Morgan committed
4
5
6

## Download

Jeffrey Morgan's avatar
Jeffrey Morgan committed
7
- [macOS](https://ollama.ai/download/darwin_arm64) (Apple Silicon)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
8
9
10
11
12
- macOS (Intel – Coming soon)
- Windows (Coming soon)
- Linux (Coming soon)

## Python SDK
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13
14

```
Bruce MacDonald's avatar
Bruce MacDonald committed
15
pip install ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
17
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
18
### Python SDK quickstart
Jeffrey Morgan's avatar
Jeffrey Morgan committed
19

Bruce MacDonald's avatar
Bruce MacDonald committed
20
21
```python
import ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
22
ollama.generate("./llama-7b-ggml.bin", "hi")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
23
24
```

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
27
Generate a completion
Bruce MacDonald's avatar
Bruce MacDonald committed
28
29

```python
Jeffrey Morgan's avatar
Jeffrey Morgan committed
30
ollama.generate("./llama-7b-ggml.bin", "hi")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
31
32
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
33
### `ollama.load(model)`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
34

Jeffrey Morgan's avatar
Jeffrey Morgan committed
35
Load a model for generation
Jeffrey Morgan's avatar
Jeffrey Morgan committed
36

Bruce MacDonald's avatar
Bruce MacDonald committed
37
```python
Jeffrey Morgan's avatar
Jeffrey Morgan committed
38
ollama.load("model")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
39
40
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
41
### `ollama.models()`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
42

Jeffrey Morgan's avatar
Jeffrey Morgan committed
43
List available local models
Bruce MacDonald's avatar
Bruce MacDonald committed
44
45
46

```
models = ollama.models()
Jeffrey Morgan's avatar
Jeffrey Morgan committed
47
48
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
49
### `ollama.serve()`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
50

Bruce MacDonald's avatar
Bruce MacDonald committed
51
Serve the ollama http server
Jeffrey Morgan's avatar
Jeffrey Morgan committed
52

Bruce MacDonald's avatar
Bruce MacDonald committed
53
### `ollama.add(filepath)`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
54

Bruce MacDonald's avatar
Bruce MacDonald committed
55
Add a model by importing from a file
Bruce MacDonald's avatar
Bruce MacDonald committed
56
57

```python
Bruce MacDonald's avatar
Bruce MacDonald committed
58
ollama.add("./path/to/model")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
59
60
```

Bruce MacDonald's avatar
Bruce MacDonald committed
61
## Cooming Soon
Bruce MacDonald's avatar
Bruce MacDonald committed
62

Bruce MacDonald's avatar
Bruce MacDonald committed
63
64
65
### `ollama.pull(model)`

Download a model
Bruce MacDonald's avatar
Bruce MacDonald committed
66
67

```python
Bruce MacDonald's avatar
Bruce MacDonald committed
68
ollama.pull("huggingface.co/thebloke/llama-7b-ggml")
Bruce MacDonald's avatar
Bruce MacDonald committed
69
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
70

Jeffrey Morgan's avatar
Jeffrey Morgan committed
71
### `ollama.search("query")`
72

Bruce MacDonald's avatar
Bruce MacDonald committed
73
Search for compatible models that Ollama can run
74

Bruce MacDonald's avatar
Bruce MacDonald committed
75
76
77
```python
ollama.search("llama-7b")
```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
78

Bruce MacDonald's avatar
Bruce MacDonald committed
79
## Future CLI
80

Jeffrey Morgan's avatar
Jeffrey Morgan committed
81
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
82

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

## Documentation

- [Development](docs/development.md)