diff --git a/docs/modelfile.md b/docs/modelfile.md index f49956cb..832f9556 100644 --- a/docs/modelfile.md +++ b/docs/modelfile.md @@ -35,6 +35,7 @@ INSTRUCTION arguments | [`PARAMETER`](#parameter) | Sets the parameters for how Ollama will run the model. | | [`TEMPLATE`](#template) | The full prompt template to be sent to the model. | | [`SYSTEM`](#system) | Specifies the system prompt that will be set in the template. | +| [`ADAPTER`](#adapter) | Defines the (Q)LoRA adapters to apply to the model. | | [`LICENSE`](#license) | Specifies the legal license. | ## Examples @@ -150,6 +151,14 @@ The `SYSTEM` instruction specifies the system prompt to be used in the template, SYSTEM """""" ``` +### ADAPTER + +The `ADAPTER` instruction specifies the LoRA adapter to apply to the base model. The value of this instruction should be an absolute path or a path relative to the Modelfile and the file must be in a GGML file format. The adapter should be tuned from the base model otherwise the behaviour is undefined. + +``` +ADAPTER ./ollama-lora.bin +``` + ### LICENSE The `LICENSE` instruction allows you to specify the legal license under which the model used with this Modelfile is shared or distributed. @@ -163,4 +172,4 @@ 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. \ No newline at end of file +- Instructions can be in any order. In the examples, we start with FROM instruction to keep it easily readable.