From 742226625f552b856ae42f200e351a2bc61a0a38 Mon Sep 17 00:00:00 2001 From: Michael Yang Date: Fri, 1 Sep 2023 10:54:31 -0400 Subject: [PATCH] update readme --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2d638497..598ccb87 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,14 @@ Here are some example open-source models that can be downloaded: ## Examples +### Pull a public model + +``` +ollama pull llama2 +``` + +> This command can also be used to update a local model. Only updated changes will be pulled. + ### Run a model ``` @@ -67,7 +75,7 @@ For multiline input, you can wrap text with `"""`: I'm a basic program that prints the famous "Hello, world!" message to the console. ``` -### Create a custom model +### Customize a model Pull a base model: @@ -75,8 +83,6 @@ Pull a base model: ollama pull llama2 ``` -> To update a model to the latest version, run `ollama pull llama2` again. The model will be updated (if necessary). - Create a `Modelfile`: ``` @@ -102,23 +108,23 @@ Hello! It's your friend Mario. For more examples, see the [examples](./examples) directory. For more information on creating a Modelfile, see the [Modelfile](./docs/modelfile.md) documentation. -### Pull a model from the registry - -``` -ollama pull orca-mini -``` - ### Listing local models ``` ollama list ``` +### Removing local models + +``` +ollama rm llama2 +``` + ## Model packages ### Overview -Ollama bundles model weights, configuration, and data into a single package, defined by a [Modelfile](./docs/modelfile.md). +Ollama bundles model weights, configurations, and data into a single package, defined by a [Modelfile](./docs/modelfile.md). @@ -146,7 +152,7 @@ Next, start the server: ./ollama serve ``` -Finally, run a model (in another shell): +Finally, in a separate shell, run a model: ``` ./ollama run llama2