瀏覽代碼

Add embedding docs

Bruce MacDonald 1 年之前
父節點
當前提交
3ceac05108
共有 1 個文件被更改,包括 26 次插入0 次删除
  1. 26 0
      docs/modelfile.md

+ 26 - 0
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 <model name>:<tag>
+EMBED <file path>
+```
+
 ### PARAMETER
 
 The `PARAMETER` instruction defines a parameter that can be set when the model is run.
 
 ```
+
 PARAMETER <parameter> <parametervalue>
+
 ```
 
 ### Valid Parameters and Values
@@ -127,19 +139,25 @@ PARAMETER <parameter> <parametervalue>
 | `{{ .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 message>"""
+
 ```
 
 ### SYSTEM
@@ -147,7 +165,9 @@ SYSTEM """<system message>"""
 The `SYSTEM` instruction specifies the system prompt to be used in the template, if applicable.
 
 ```
+
 SYSTEM """<system message>"""
+
 ```
 
 ### LICENSE
@@ -155,12 +175,18 @@ SYSTEM """<system message>"""
 The `LICENSE` instruction allows you to specify the legal license under which the model used with this Modelfile is shared or distributed.
 
 ```
+
 LICENSE """
 <license text>
 """
+
 ```
 
 ## 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.
+
+```
+
+```