Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,90 @@
 ---
-license: apache-2.0
+language:
+- en
+license: other
+license_name: llama3
+model_name: Llama-3-Instruct-8B-SimPO
+base_model: princeton-nlp/Llama-3-Instruct-8B-SimPO
+inference: false
+model_creator: princeton-nlp
+model_type: llama
+pipeline_tag: text-generation
+quantized_by: Second State Inc.
 ---
+
+<!-- header start -->
+<!-- 200823 -->
+<div style="width: auto; margin-left: auto; margin-right: auto">
+<img src="https://github.com/LlamaEdge/LlamaEdge/raw/dev/assets/logo.svg" style="width: 100%; min-width: 400px; display: block; margin: auto;">
+</div>
+<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
+<!-- header end -->
+
+# Llama-3-Instruct-8B-SimPO-GGUF
+
+## Original Model
+
+[meta-llama/Llama-3-Instruct-8B-SimPO](https://huggingface.co/princeton-nlp/Llama-3-Instruct-8B-SimPO)
+
+## Run with LlamaEdge
+
+- LlamaEdge version: [v0.11.2](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.11.2)
+
+- Prompt template
+
+  - Prompt type: `llama-3-chat`
+
+  - Prompt string
+
+    ```text
+    <|begin_of_text|><|start_header_id|>system<|end_header_id|>
+
+    {{ system_prompt }}<|eot_id|><|start_header_id|>user<|end_header_id|>
+
+    {{ user_message_1 }}<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+
+    {{ model_answer_1 }}<|eot_id|><|start_header_id|>user<|end_header_id|>
+
+    {{ user_message_2 }}<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+    ```
+
+- Context size: `4096`
+
+- Run as LlamaEdge service
+
+  ```bash
+  wasmedge --dir .:. --nn-preload default:GGML:AUTO:Llama-3-Instruct-8B-SimPO-Q5_K_M.gguf \
+    llama-api-server.wasm \
+    --prompt-template llama-3-chat \
+    --ctx-size 4096 \
+    --model-name Llama-3-8b
+  ```
+
+- Run as LlamaEdge command app
+
+  ```bash
+  wasmedge --dir .:. --nn-preload default:GGML:AUTO:Llama-3-Instruct-8B-SimPO-Q5_K_M.gguf \
+    llama-chat.wasm \
+    --prompt-template llama-3-chat \
+    --ctx-size 4096
+  ```
+
+## Quantized GGUF Models
+
+| Name | Quant method | Bits | Size | Use case |
+| ---- | ---- | ---- | ---- | ----- |
+| [Llama-3-Instruct-8B-SimPO-Q2_K.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q2_K.gguf)     | Q2_K   | 2 | 3.18 GB| smallest, significant quality loss - not recommended for most purposes |
+| [Llama-3-Instruct-8B-SimPO-Q3_K_L.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q3_K_L.gguf) | Q3_K_L | 3 | 4.32 GB| small, substantial quality loss |
+| [Llama-3-Instruct-8B-SimPO-Q3_K_M.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q3_K_M.gguf) | Q3_K_M | 3 | 4.02 GB| very small, high quality loss |
+| [Llama-3-Instruct-8B-SimPO-Q3_K_S.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q3_K_S.gguf) | Q3_K_S | 3 | 3.66 GB| very small, high quality loss |
+| [Llama-3-Instruct-8B-SimPO-Q4_0.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q4_0.gguf)     | Q4_0   | 4 | 4.66 GB| legacy; small, very high quality loss - prefer using Q3_K_M |
+| [Llama-3-Instruct-8B-SimPO-Q4_K_M.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q4_K_M.gguf) | Q4_K_M | 4 | 4.92 GB| medium, balanced quality - recommended |
+| [Llama-3-Instruct-8B-SimPO-Q4_K_S.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q4_K_S.gguf) | Q4_K_S | 4 | 4.69 GB| small, greater quality loss |
+| [Llama-3-Instruct-8B-SimPO-Q5_0.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q5_0.gguf)     | Q5_0   | 5 | 5.6 GB| legacy; medium, balanced quality - prefer using Q4_K_M |
+| [Llama-3-Instruct-8B-SimPO-Q5_K_M.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q5_K_M.gguf) | Q5_K_M | 5 | 5.73 GB| large, very low quality loss - recommended |
+| [Llama-3-Instruct-8B-SimPO-Q5_K_S.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q5_K_S.gguf) | Q5_K_S | 5 | 5.6 GB| large, low quality loss - recommended |
+| [Llama-3-Instruct-8B-SimPO-Q6_K.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q6_K.gguf)     | Q6_K   | 6 | 6.6 GB| very large, extremely low quality loss |
+| [Llama-3-Instruct-8B-SimPO-Q8_0.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-Q8_0.gguf)     | Q8_0   | 8 | 8.54 GB| very large, extremely low quality loss - not recommended |
+| [Llama-3-Instruct-8B-SimPO-f16.gguf](https://huggingface.co/second-state/Llama-3-Instruct-8B-SimPO-GGUF/blob/main/Llama-3-Instruct-8B-SimPO-f16.gguf)     | f16   | 16 | 16.1 GB|  |
+
+*Quantized with llama.cpp b2963.*