From 43c40c500e2f2407bca69ebcbdc92cd3bded52db Mon Sep 17 00:00:00 2001 From: Bruce MacDonald Date: Wed, 9 Aug 2023 16:14:58 -0400 Subject: [PATCH 1/2] add embed docs for modelfile --- docs/modelfile.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/modelfile.md b/docs/modelfile.md index f49956cb..a90cbc0d 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,6 +89,15 @@ 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. From 9ae9a8988311feaf11d5c5174109ea94909c1011 Mon Sep 17 00:00:00 2001 From: Bruce MacDonald Date: Mon, 14 Aug 2023 16:26:53 -0300 Subject: [PATCH 2/2] Update modelfile.md --- docs/modelfile.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/modelfile.md b/docs/modelfile.md index a90cbc0d..1189933d 100644 --- a/docs/modelfile.md +++ b/docs/modelfile.md @@ -91,11 +91,12 @@ This bin file location should be specified as an absolute path or relative to th ### 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. - +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. Note that currently only text files are supported, formatted with each line as one embedding. ``` FROM : -EMBED +EMBED .txt +EMBED .txt +EMBED /*.txt ``` ### PARAMETER