From 3ceac05108fec492b8957370677f06de4dffea64 Mon Sep 17 00:00:00 2001 From: Bruce MacDonald Date: Tue, 8 Aug 2023 14:04:11 -0400 Subject: [PATCH] Add embedding docs --- docs/modelfile.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/modelfile.md b/docs/modelfile.md index 3e8a7ee84..77dd765bc 100644 --- a/docs/modelfile.md +++ b/docs/modelfile.md @@ -12,6 +12,7 @@ A model file is the blueprint to create and share models with Ollama. - [FROM (Required)](#from-required) - [Build from llama2](#build-from-llama2) - [Build from a bin file](#build-from-a-bin-file) + - [EMBED](#embed) - [PARAMETER](#parameter) - [Valid Parameters and Values](#valid-parameters-and-values) - [TEMPLATE](#template) @@ -88,12 +89,23 @@ FROM ./ollama-model.bin This bin file location should be specified as an absolute path or relative to the Modelfile location. +### EMBED + +The EMBED instruction is used to add embeddings of files to a model. This is useful for adding custom data that the model can reference when generating an answer. + +``` +FROM : +EMBED +``` + ### PARAMETER The `PARAMETER` instruction defines a parameter that can be set when the model is run. ``` + PARAMETER + ``` ### Valid Parameters and Values @@ -127,19 +139,25 @@ PARAMETER | `{{ .First }}` | A boolean value used to render specific template information for the first generation of a session. | ``` + TEMPLATE """ {{- if .First }} + ### System: + {{ .System }} {{- end }} ### User: + {{ .Prompt }} ### Response: + """ SYSTEM """""" + ``` ### SYSTEM @@ -147,7 +165,9 @@ SYSTEM """""" The `SYSTEM` instruction specifies the system prompt to be used in the template, if applicable. ``` + SYSTEM """""" + ``` ### LICENSE @@ -155,12 +175,18 @@ SYSTEM """""" The `LICENSE` instruction allows you to specify the legal license under which the model used with this Modelfile is shared or distributed. ``` + LICENSE """ """ + ``` ## Notes - the **modelfile is not case sensitive**. In the examples, we use uppercase for instructions to make it easier to distinguish it from arguments. - Instructions can be in any order. In the examples, we start with FROM instruction to keep it easily readable. + +``` + +```