README.md 899 Bytes
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
# ollama
Jeffrey Morgan's avatar
Jeffrey Morgan committed
2

Jeffrey Morgan's avatar
Jeffrey Morgan committed
3
4
5
6
7
🙊

## Running

Install dependencies:
Jeffrey Morgan's avatar
Jeffrey Morgan committed
8
9

```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
10
pip install -r requirements.txt
Jeffrey Morgan's avatar
Jeffrey Morgan committed
11
12
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
13
14
15
Put your model in `models/` and run:

```
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
python3 ollama.py serve
Jeffrey Morgan's avatar
Jeffrey Morgan committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
```

To run the app:

```
cd desktop
npm install
npm start
```

## Building

If using Apple silicon, you need a Python version that supports arm64:

```bash
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh
bash Miniforge3-MacOSX-arm64.sh
```

Get the dependencies:

```bash
pip install -r requirements.txt
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
42
43
Then build a binary for your current platform:

Jeffrey Morgan's avatar
Jeffrey Morgan committed
44
45
46
47
```bash
python3 build.py
```

Jeffrey Morgan's avatar
Jeffrey Morgan committed
48
### Building the app
Jeffrey Morgan's avatar
Jeffrey Morgan committed
49
50
51
52
53
54
55
56

```
cd desktop
npm run package
```

## API

57
58
59
60
### `GET /models`

Returns a list of available models

Jeffrey Morgan's avatar
Jeffrey Morgan committed
61
62
### `POST /generate`

63
64
Generates completions as a series of JSON objects

Jeffrey Morgan's avatar
Jeffrey Morgan committed
65
66
model: `string` - The name of the model to use in the `models` folder.
prompt: `string` - The prompt to use.