baalajimaestro/ollama
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #125 from jmorganca/matt/addlicensetomodelfiledoc

Browse source 
Updated modelfile doc to include license
This commit is contained in:
Matt Williams 2023-07-19 08:57:06 -07:00 • committed by GitHub
commit 75eb28f574
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/modelfile.md
View file

@ -25,14 +25,24 @@ FROM <image>[:<tag>]
This defines the base model to be used. An image can be a known image on the Ollama Hub, or a fully-qualified path to a model file on your system This defines the base model to be used. An image can be a known image on the Ollama Hub, or a fully-qualified path to a model file on your system
## PARAMETER ## LICENSE
The PARAMETER instruction defines a parameter that can be set when the model is run. ```modelfile
LICENSE """
<license text>
"""
```
Some models need to be distributed with a license agreement. For example, the distribution clause for the Llama2 license requires including the license with the model.
## PARAMETER
```modelfile ```modelfile
PARAMETER <parameter> <parametervalue> PARAMETER <parameter> <parametervalue>
``` ```
The PARAMETER instruction defines a parameter that can be set when the model is run.
### Valid Parameters and Values ### Valid Parameters and Values
| Parameter | Description | Value Type | Value Range | | Parameter | Description | Value Type | Value Range |

3
examples/midjourneyprompter
View file

@ -1,7 +1,8 @@
# Modelfile for creating a Midjourney prompts from a topic # Modelfile for creating a Midjourney prompts from a topic
# This prompt was adapted from the original at https://www.greataiprompts.com/guide/midjourney/best-chatgpt-prompt-for-midjourney/
# Run `ollama create mj -f pathtofile` and then `ollama run mj` and enter a topic # Run `ollama create mj -f pathtofile` and then `ollama run mj` and enter a topic
FROM library/nous-hermes:latest FROM nous-hermes
PROMPT """ PROMPT """
{{- if not .Context }} {{- if not .Context }}
### System: ### System:

2
examples/recipemaker
View file

@ -1,6 +1,6 @@
# Modelfile for creating a recipe from a list of ingredients # Modelfile for creating a recipe from a list of ingredients
# Run `ollama create recipemaker -f pathtofile` and then `ollama run recipemaker` and feed it lists of ingredients to create recipes around. # Run `ollama create recipemaker -f pathtofile` and then `ollama run recipemaker` and feed it lists of ingredients to create recipes around.
FROM library/nous-hermes:latest FROM nous-hermes
PROMPT """ PROMPT """
{{- if not .Context }} {{- if not .Context }}
### System: ### System:

2
examples/tweetwriter
View file

@ -1,7 +1,7 @@
# Modelfile for creating a tweet from a topic # Modelfile for creating a tweet from a topic
# Run `ollama create tweetwriter -f pathtofile` and then `ollama run tweetwriter` and enter a topic # Run `ollama create tweetwriter -f pathtofile` and then `ollama run tweetwriter` and enter a topic
FROM library/nous-hermes:latest FROM nous-hermes
PROMPT """ PROMPT """
{{- if not .Context }} {{- if not .Context }}
### System: ### System: