README.md 1.46 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
![header](https://github.com/jmorganca/ollama/assets/251292/98204129-c676-4ab5-be98-bcc45ba8e9e7)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
4

Jeffrey Morgan's avatar
Jeffrey Morgan committed
5
6
7
8
9
10
11
12
13
14
The easiest way to run download and run ai models.

## Download

- [macOS](https://ollama.ai/download/darwin) (Apple Silicon)
- macOS (Intel – Coming soon)
- Windows (Coming soon)
- Linux (Coming soon)

## Python SDK
Jeffrey Morgan's avatar
Jeffrey Morgan committed
15
16

```
Bruce MacDonald's avatar
Bruce MacDonald committed
17
pip install ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
18
19
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
20
### Python SDK quickstart
Jeffrey Morgan's avatar
Jeffrey Morgan committed
21

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
29
Generate a completion
Bruce MacDonald's avatar
Bruce MacDonald committed
30
31

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
35
### `ollama.load(model)`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
36

Jeffrey Morgan's avatar
Jeffrey Morgan committed
37
Load a model for generation
Jeffrey Morgan's avatar
Jeffrey Morgan committed
38

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
45
List available local models
Bruce MacDonald's avatar
Bruce MacDonald committed
46
47
48

```
models = ollama.models()
Jeffrey Morgan's avatar
Jeffrey Morgan committed
49
50
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
51
### `ollama.serve()`
Jeffrey Morgan's avatar
Jeffrey Morgan committed
52

Bruce MacDonald's avatar
Bruce MacDonald committed
53
Serve the ollama http server
Jeffrey Morgan's avatar
Jeffrey Morgan committed
54

Jeffrey Morgan's avatar
Jeffrey Morgan committed
55
## Cooming Soon
Jeffrey Morgan's avatar
Jeffrey Morgan committed
56

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
59
Download a model
Bruce MacDonald's avatar
Bruce MacDonald committed
60
61
62

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
67
Import a model from a file
Bruce MacDonald's avatar
Bruce MacDonald committed
68
69
70
71

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
73
### `ollama.search("query")`
74

Bruce MacDonald's avatar
Bruce MacDonald committed
75
Search for compatible models that Ollama can run
76

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

Bruce MacDonald's avatar
Bruce MacDonald committed
81
## Future CLI
82

Jeffrey Morgan's avatar
Jeffrey Morgan committed
83
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
84

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

## Documentation

- [Development](docs/development.md)