Upload README.md (#5)

- Upload README.md (4618770209d7acf427b34c5ae59da6a46e2ed5d9)


Co-authored-by: qt-spyro-hf <[email protected]>

README.md

@@ -16,13 +16,57 @@ CodeLlama-13B-QML is a large language model customized by the Qt Company for Fil
  ## Terms of use:
 By accessing this model, you are agreeing to the Llama 2 terms and conditions of the [license](https://github.com/meta-llama/llama/blob/main/LICENSE), [acceptable use policy](https://github.com/meta-llama/llama/blob/main/USE_POLICY.md) and [Meta’s privacy policy](https://www.facebook.com/privacy/policy/). By using this model, you are furthermore agreeing to [Qt AI Model terms & conditions](https://www.qt.io/terms-conditions). 
 
+ ## Usage:
+Large language models, including CodeLlama-13B-QML, are not designed to be deployed in isolation but instead should be deployed as part of an overall AI system with additional safety guardrails as required. Developers are expected to deploy system safeguards when building AI systems.
 
-## Attribution:
-CodeLlama 13B is licensed under the Llama 3.2 Community License, Copyright © Meta Platforms, Inc. All Rights Reserved.
+## How to run in ollama
+#### Install the ollama
+https://ollama.com/download
 
-## Usage:
-Large language models, including CodeLlama-13B-QML, are not designed to be deployed in isolation but instead should be deployed as part of an overall AI system with additional safety guardrails as required. Developers are expected to deploy system safeguards when building AI systems.
+instructions written with ollama version 0.5.7 
+
+#### Download model repository
+
+#### Open terminal and go to the repository
+
+#### Build model in ollama
+```
+ollama create <your-model-name> -f Modelfile
+e.g. ollama create customcodellama13bqml -f Modelfile
+```
+
+#### Run the model
+```
+ollama run <your-model-name>
+e.g. ollama run customcodellame13bqml
+```
+You can start writing in the terminal or send curl requests
+
+Curl request example:
+```
+curl -X POST http://localhost:11434/api/generate -d '{
+  "model": "codellama13bqml",
+  "Prompt": "<SUF>\n    title: qsTr(\"Hello World\")\n}<PRE>import QtQuick\n\nWindow {\n    width: 640\n    height: 480\n    visible: true\n<MID>",
+  "stream": false,
+  "temperature": 0.4,
+  "top_p": 0.9,
+  "repeat_penalty": 1.1,
+  "num_predict": 300,
+  "stop": ["<SUF>", "<PRE>", "</PRE>", "</SUF>", "< EOT >", "\\end", "<MID>", "</MID>", "##"]
+}'
+```
+
+#### The prompt format:
+```
+"<SUF>{suffix}<PRE>{prefix}<MID>"
+```
+
+If there is no suffix, please use:
+```
+"<PRE>{prefix}<MID>"
+```
 
+#### Happy coding!
 
 ## Model Version:
 v1.0