clean up README.md

This commit is contained in:
Jeffrey Morgan 2023-07-20 12:21:29 -07:00
parent 992892866b
commit 23a37dc466

View file

@ -11,25 +11,7 @@
> Note: Ollama is in early preview. Please report any issues you find. > Note: Ollama is in early preview. Please report any issues you find.
Create, run, and share portable large language models (LLMs). Ollama bundles a models weights, configuration, prompts, and more into self-contained packages that can run on any machine. Run, create, and share large language models (LLMs).
### Portable Large Language Models (LLMs)
Package models as a series of layers in a portable, easy to manage format.
#### The idea behind Ollama
- Universal model format that can run anywhere: desktop, cloud servers & other devices.
- Encapsulate everything a model needs to operate weights, configuration, and data into a single package.
- Build custom models from base models like Meta's [Llama 2](https://ai.meta.com/llama/)
- Share large models without having to transmit large amounts of data.
<picture>
<source media="(prefers-color-scheme: dark)" height="480" srcset="https://github.com/jmorganca/ollama/assets/251292/2e05cf23-e3c6-403e-9910-3d622801f4b8">
<img alt="logo" height="480" src="https://github.com/jmorganca/ollama/assets/251292/2e05cf23-e3c6-403e-9910-3d622801f4b8">
</picture>
This format is inspired by the [image spec](https://github.com/opencontainers/image-spec) originally introduced by Docker for Linux containers. Ollama extends this format to package large language models.
## Download ## Download
@ -47,7 +29,7 @@ ollama run llama2
## Model library ## Model library
Ollama includes a library of open-source, pre-trained models. More models are coming soon. You should have at least 8 GB of RAM to run the 3B models, 16 GB to run the 7B models, and 32 GB to run the 13B models. `ollama` includes a library of open-source models:
| Model | Parameters | Size | Download | | Model | Parameters | Size | Download |
| ------------------------ | ---------- | ----- | --------------------------- | | ------------------------ | ---------- | ----- | --------------------------- |
@ -58,6 +40,8 @@ Ollama includes a library of open-source, pre-trained models. More models are co
| Nous-Hermes | 13B | 7.3GB | `ollama pull nous-hermes` | | Nous-Hermes | 13B | 7.3GB | `ollama pull nous-hermes` |
| Wizard Vicuna Uncensored | 13B | 7.3GB | `ollama pull wizard-vicuna` | | Wizard Vicuna Uncensored | 13B | 7.3GB | `ollama pull wizard-vicuna` |
> Note: You should have at least 8 GB of RAM to run the 3B models, 16 GB to run the 7B models, and 32 GB to run the 13B models.
## Examples ## Examples
### Run a model ### Run a model
@ -68,7 +52,7 @@ ollama run llama2
Hello! How can I help you today? Hello! How can I help you today?
``` ```
### Create a custom character model ### Create a custom model
Pull a base model: Pull a base model:
@ -107,6 +91,23 @@ For more examples, see the [examples](./examples) directory.
ollama pull orca ollama pull orca
``` ```
### Listing local models
```
ollama list
```
## Model packages
### Overview
Ollama bundles model weights, configuration, and data into a single package, defined by a [Modelfile](./docs/modelfile.md).
<picture>
<source media="(prefers-color-scheme: dark)" height="480" srcset="https://github.com/jmorganca/ollama/assets/251292/2fd96b5f-191b-45c1-9668-941cfad4eb70">
<img alt="logo" height="480" src="https://github.com/jmorganca/ollama/assets/251292/2fd96b5f-191b-45c1-9668-941cfad4eb70">
</picture>
## Building ## Building
``` ```