瀏覽代碼

Merge pull request #125 from jmorganca/matt/addlicensetomodelfiledoc

Updated modelfile doc to include license
Matt Williams 1 年之前
父節點
當前提交
75eb28f574
共有 4 個文件被更改,包括 16 次插入5 次删除
  1. 12 2
      docs/modelfile.md
  2. 2 1
      examples/midjourneyprompter
  3. 1 1
      examples/recipemaker
  4. 1 1
      examples/tweetwriter

+ 12 - 2
docs/modelfile.md

@@ -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
 
-## PARAMETER
+## LICENSE
+
+```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. 
 
-The PARAMETER instruction defines a parameter that can be set when the model is run. 
+## PARAMETER
 
 ```modelfile
 PARAMETER <parameter> <parametervalue>
 ```
 
+The PARAMETER instruction defines a parameter that can be set when the model is run.
+
 ### Valid Parameters and Values
 
 | Parameter        | Description                                                                                 | Value Type | Value Range |

+ 2 - 1
examples/midjourneyprompter

@@ -1,7 +1,8 @@
 # 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
 
-FROM library/nous-hermes:latest
+FROM nous-hermes
 PROMPT """
 {{- if not .Context }}
 ### System:

+ 1 - 1
examples/recipemaker

@@ -1,6 +1,6 @@
 # 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.
-FROM library/nous-hermes:latest
+FROM nous-hermes
 PROMPT """
 {{- if not .Context }}
 ### System:

+ 1 - 1
examples/tweetwriter

@@ -1,7 +1,7 @@
 # Modelfile for creating a tweet from 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 """
 {{- if not .Context }}
 ### System: