ollama/README.md

81 lines
1.8 KiB
Markdown
Raw Normal View History

2023-07-18 12:45:38 -07:00
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" height="200px" srcset="https://github.com/jmorganca/ollama/assets/3325447/318048d2-b2dd-459c-925a-ac8449d5f02c">
<img alt="logo" height="200px" src="https://github.com/jmorganca/ollama/assets/3325447/c7d6e15f-7f4d-4776-b568-c084afa297c2">
</picture>
</div>
2023-07-05 15:37:33 -04:00
2023-06-27 12:08:52 -04:00
# Ollama
2023-06-22 12:45:31 -04:00
2023-07-18 13:22:33 -07:00
Create, run, and share self-contained large language models (LLMs). Ollama bundles a models weights, configuration, prompts, and more into self-contained packages that run anywhere.
2023-07-05 15:37:33 -04:00
2023-07-18 13:22:33 -07:00
> Note: Ollama is in early preview. Please report any issues you find.
2023-07-05 15:37:33 -04:00
## Download
- [Download](https://ollama.ai/download) for macOS on Apple Silicon (Intel coming soon)
- Download for Windows and Linux (coming soon)
- Build [from source](#building)
2023-07-18 13:22:33 -07:00
## Examples
2023-06-27 17:13:07 -04:00
2023-07-18 13:22:33 -07:00
### Quickstart
2023-06-22 12:45:31 -04:00
```
2023-07-18 13:22:33 -07:00
ollama run llama2
>>> hi
Hello! How can I help you today?
2023-06-22 12:45:31 -04:00
```
2023-07-18 14:03:11 -07:00
### Creating a custom model
2023-07-05 15:37:33 -04:00
2023-07-18 13:22:33 -07:00
Create a `Modelfile`:
2023-07-05 15:37:33 -04:00
2023-06-30 12:31:00 -04:00
```
2023-07-18 13:22:33 -07:00
FROM llama2
PROMPT """
2023-07-18 13:32:06 -07:00
You are Mario from Super Mario Bros. Answer as Mario, the assistant, only.
2023-06-30 12:31:00 -04:00
2023-07-18 13:22:33 -07:00
User: {{ .Prompt }}
Mario:
"""
2023-06-29 18:25:02 -04:00
```
2023-07-18 13:22:33 -07:00
Next, create and run the model:
```
2023-07-18 13:22:33 -07:00
ollama create mario -f ./Modelfile
ollama run mario
>>> hi
Hello! It's your friend Mario.
```
2023-07-18 13:22:33 -07:00
## Model library
2023-07-06 16:21:01 -04:00
2023-07-18 13:22:33 -07:00
Ollama includes a library of open-source, pre-trained models. More models are coming soon.
2023-07-06 16:21:01 -04:00
2023-07-18 13:22:33 -07:00
| Model | Parameters | Size | Download |
| ----------- | ---------- | ----- | ------------------------- |
2023-07-18 14:03:11 -07:00
| Llama2 | 7B | 3.8GB | `ollama pull llama2` |
2023-07-18 13:22:33 -07:00
| Orca Mini | 3B | 1.9GB | `ollama pull orca` |
| Vicuna | 7B | 3.8GB | `ollama pull vicuna` |
| Nous-Hermes | 13B | 7.3GB | `ollama pull nous-hermes` |
2023-06-28 09:57:36 -04:00
2023-07-03 16:32:48 -04:00
## Building
```
2023-07-11 09:50:02 -07:00
go build .
2023-07-03 16:32:48 -04:00
```
2023-07-05 15:37:33 -04:00
To run it start the server:
2023-06-27 13:46:46 -04:00
2023-07-05 15:37:33 -04:00
```
./ollama server &
```
Finally, run a model!
```
2023-07-18 13:22:33 -07:00
./ollama run llama2
2023-07-05 15:37:33 -04:00
```