Create README.md

README.md

@@ -0,0 +1,50 @@
+---
+license: mit
+---
+
+
+## About llamafile
+<a href="https://github.com/Mozilla-Ocho/llamafile" target="_blank">github</a><br/>
+<a href="https://www.bingal.com/posts/ai-llamafile-usage/" target="_blank">llamafile 中文说明</a><br/>
+<a href="https://www.modelscope.cn/models/bingal/llamafile-models/summary" target="_blank">The llamafile model collection in modelscope.cn</a><br/>
+<a href="https://www.modelscope.cn/models/bingal/Qwen1.5-14B-Chat-llamafile/summary" target="_blank">Qwen1.5-14B-Chat-llamafile in modelscope.cn</a>
+
+## Useage
+
+1. Download model: `qwen1.5-14b-chat-q5_k_m.llamafile`
+2. Run the model
+    * Windows
+        1. Rename the file to `qwen1.5-14b-chat-q5_k_m.exe`
+        2. Open terminal window, and run: `\qwen1.5-14b-chat-q5_k_m.exe`
+        3. Open browser to http://127.0.0.1:8080 to start chatting
+    * Linux / macOS
+        1. Add execution permissions: `chmod +x ./qwen1.5-14b-chat-q5_k_m.llamafile`
+        2. Run in terminal: `./qwen1.5-14b-chat-q5_k_m.llamafile`
+        3. Open browser to http://127.0.0.1:8080 to start chatting
+3. Openai api usage
+   * api url: `http://127.0.0.1:8080/v1`
+   * Python code:
+   ```python
+   #!/usr/bin/env python3
+   from openai import OpenAI
+   client = OpenAI(
+       base_url="http://127.0.0.1:8080/v1", # "http://<Your api-server IP>:port"
+       api_key = "sk-no-key-required"
+   )
+   completion = client.chat.completions.create(
+       model="LLaMA_CPP",
+       messages=[
+           {"role": "system", "content": "You are an AI assistant."},
+           {"role": "user", "content": "Write a story about dragon"}
+       ]
+   )
+   print(completion.choices[0].message)
+    ```
+
+## Parameter Description
+
+- `-ngl 9999` indicates how many layers of the model are placed on the GPU to run, with the rest running on the CPU. If there is no GPU available, it can be set to `-ngl 0`. The default is 9999, which means everything runs on the GPU (drivers and CUDA runtime environment must be installed).
+- `--host 0.0.0.0` is the hostname for the web service. If only local access is needed, it can be set to `--host 127.0.0.1`. If set to `0.0.0.0`, it can be accessed via IP within the network.
+- `--port 8080` is the port for the web service, with the default being `8080`, which can be modified using this parameter.
+- `-t 16` is the number of threads. When running on the CPU, you can set the number of cores to run concurrently based on the CPU core count.
+- Other parameters can be viewed with `--help`.