forked from Mirror/ollama4j
updated docs
This commit is contained in:
Amith Koujalgi
parent
3bd99cd1e8
commit
a8b7117878
@ -6,6 +6,8 @@ sidebar_position: 4
|
|||||||
|
|
||||||
This API lets you create a custom model on the Ollama server.
|
This API lets you create a custom model on the Ollama server.
|
||||||
|
|
||||||
|
### Create a model from an existing Modelfile in the Ollama server
|
||||||
|
|
||||||
```java title="CreateModel.java"
|
```java title="CreateModel.java"
|
||||||
public class CreateModel {
|
public class CreateModel {
|
||||||
|
|
||||||
@ -15,9 +17,144 @@ public class CreateModel {
|
|||||||
|
|
||||||
OllamaAPI ollamaAPI = new OllamaAPI(host);
|
OllamaAPI ollamaAPI = new OllamaAPI(host);
|
||||||
|
|
||||||
ollamaAPI.createModel("mycustommodel", "/path/to/modelfile/on/ollama-server");
|
ollamaAPI.createModelWithFilePath("mario", "/path/to/mario/modelfile/on/ollama-server");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Once created, you can see it when you use [list models](./list-models) API.
|
### Create a model by passing the contents of Modelfile
|
||||||
|
|
||||||
|
```java title="CreateModel.java"
|
||||||
|
public class CreateModel {
|
||||||
|
|
||||||
|
public static void main(String[] args) {
|
||||||
|
|
||||||
|
String host = "http://localhost:11434/";
|
||||||
|
|
||||||
|
OllamaAPI ollamaAPI = new OllamaAPI(host);
|
||||||
|
|
||||||
|
ollamaAPI.createModelWithModelFileContents("mario", "FROM llama2\nSYSTEM You are mario from Super Mario Bros.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Once created, you can see it when you use [list models](./list-models) API.
|
||||||
|
|
||||||
|
### Example of a `Modelfile`
|
||||||
|
|
||||||
|
```
|
||||||
|
FROM llama2
|
||||||
|
# sets the temperature to 1 [higher is more creative, lower is more coherent]
|
||||||
|
PARAMETER temperature 1
|
||||||
|
# sets the context window size to 4096, this controls how many tokens the LLM can use as context to generate the next token
|
||||||
|
PARAMETER num_ctx 4096
|
||||||
|
|
||||||
|
# sets a custom system message to specify the behavior of the chat assistant
|
||||||
|
SYSTEM You are Mario from super mario bros, acting as an assistant.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Format of the `Modelfile`
|
||||||
|
|
||||||
|
```modelfile
|
||||||
|
# comment
|
||||||
|
INSTRUCTION arguments
|
||||||
|
```
|
||||||
|
|
||||||
|
| Instruction | Description |
|
||||||
|
|-------------------------------------|----------------------------------------------------------------|
|
||||||
|
| [`FROM`](#from-required) (required) | Defines the base model to use. |
|
||||||
|
| [`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 message 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. |
|
||||||
|
|
||||||
|
#### PARAMETER
|
||||||
|
|
||||||
|
The `PARAMETER` instruction defines a parameter that can be set when the model is run.
|
||||||
|
|
||||||
|
| Parameter | Description | Value Type | Example Usage |
|
||||||
|
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------------------|
|
||||||
|
| mirostat | Enable Mirostat sampling for controlling perplexity. (default: 0, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0) | int | mirostat 0 |
|
||||||
|
| mirostat_eta | Influences how quickly the algorithm responds to feedback from the generated text. A lower learning rate will result in slower adjustments, while a higher learning rate will make the algorithm more responsive. (Default: 0.1) | float | mirostat_eta 0.1 |
|
||||||
|
| mirostat_tau | Controls the balance between coherence and diversity of the output. A lower value will result in more focused and coherent text. (Default: 5.0) | float | mirostat_tau 5.0 |
|
||||||
|
| num_ctx | Sets the size of the context window used to generate the next token. (Default: 2048) | int | num_ctx 4096 |
|
||||||
|
| num_gqa | The number of GQA groups in the transformer layer. Required for some models, for example it is 8 for llama2:70b | int | num_gqa 1 |
|
||||||
|
| num_gpu | The number of layers to send to the GPU(s). On macOS it defaults to 1 to enable metal support, 0 to disable. | int | num_gpu 50 |
|
||||||
|
| num_thread | Sets the number of threads to use during computation. By default, Ollama will detect this for optimal performance. It is recommended to set this value to the number of physical CPU cores your system has (as opposed to the logical number of cores). | int | num_thread 8 |
|
||||||
|
| repeat_last_n | Sets how far back for the model to look back to prevent repetition. (Default: 64, 0 = disabled, -1 = num_ctx) | int | repeat_last_n 64 |
|
||||||
|
| repeat_penalty | Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penalize repetitions more strongly, while a lower value (e.g., 0.9) will be more lenient. (Default: 1.1) | float | repeat_penalty 1.1 |
|
||||||
|
| temperature | The temperature of the model. Increasing the temperature will make the model answer more creatively. (Default: 0.8) | float | temperature 0.7 |
|
||||||
|
| seed | Sets the random number seed to use for generation. Setting this to a specific number will make the model generate the same text for the same prompt. (Default: 0) | int | seed 42 |
|
||||||
|
| stop | Sets the stop sequences to use. When this pattern is encountered the LLM will stop generating text and return. Multiple stop patterns may be set by specifying multiple separate `stop` parameters in a modelfile. | string | stop "AI assistant:" |
|
||||||
|
| tfs_z | Tail free sampling is used to reduce the impact of less probable tokens from the output. A higher value (e.g., 2.0) will reduce the impact more, while a value of 1.0 disables this setting. (default: 1) | float | tfs_z 1 |
|
||||||
|
| num_predict | Maximum number of tokens to predict when generating text. (Default: 128, -1 = infinite generation, -2 = fill context) | int | num_predict 42 |
|
||||||
|
| top_k | Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative. (Default: 40) | int | top_k 40 |
|
||||||
|
| top_p | Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text. (Default: 0.9) | float | top_p 0.9 |
|
||||||
|
|
||||||
|
#### TEMPLATE
|
||||||
|
|
||||||
|
`TEMPLATE` of the full prompt template to be passed into the model. It may include (optionally) a system message and a
|
||||||
|
user's prompt. This is used to create a full custom prompt, and syntax may be model specific. You can usually find the
|
||||||
|
template for a given model in the readme for that model.
|
||||||
|
|
||||||
|
#### Template Variables
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|-----------------|---------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `{{ .System }}` | The system message used to specify custom behavior, this must also be set in the Modelfile as an instruction. |
|
||||||
|
| `{{ .Prompt }}` | The incoming prompt, this is not specified in the model file and will be set based on input. |
|
||||||
|
| `{{ .First }}` | A boolean value used to render specific template information for the first generation of a session. |
|
||||||
|
|
||||||
|
```modelfile
|
||||||
|
TEMPLATE """
|
||||||
|
{{- if .First }}
|
||||||
|
### System:
|
||||||
|
{{ .System }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
### User:
|
||||||
|
{{ .Prompt }}
|
||||||
|
|
||||||
|
### Response:
|
||||||
|
"""
|
||||||
|
|
||||||
|
SYSTEM """<system message>"""
|
||||||
|
```
|
||||||
|
|
||||||
|
### SYSTEM
|
||||||
|
|
||||||
|
The `SYSTEM` instruction specifies the system message to be used in the template, if applicable.
|
||||||
|
|
||||||
|
```modelfile
|
||||||
|
SYSTEM """<system message>"""
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
```modelfile
|
||||||
|
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.
|
||||||
|
|
||||||
|
```modelfile
|
||||||
|
LICENSE """
|
||||||
|
<license text>
|
||||||
|
"""
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- the **`Modelfile` is not case sensitive**. In the examples, uppercase instructions are used to make it easier to
|
||||||
|
distinguish it from arguments.
|
||||||
|
- Instructions can be in any order. In the examples, the `FROM` instruction is first to keep it easily readable.
|
||||||
|
|
||||||
|
Read more about Modelfile: https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md
|
||||||
Loading…
x
Reference in New Issue
Block a user