Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,84 @@
 ---
-license: apache-2.0
+license: cc-by-nc-sa-4.0
+pipeline_tag: text-generation
+base_model: SciPhi/Triplex
+model_creator: SciPhi
+model_name: Triplex
+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 -->
+
+# Triplex-GGUF
+
+## Original Model
+
+[SciPhi/Triplex](https://huggingface.co/SciPhi/Triplex)
+
+## Run with LlamaEdge
+
+- LlamaEdge version: coming soon
+
+<!-- - LlamaEdge version: [v0.12.3](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.12.3) and above
+
+- Prompt template
+
+  - Prompt type: `chatml`
+
+  - Prompt string
+
+    ```text
+    <|im_start|>system
+    {system_message}<|im_end|>
+    <|im_start|>user
+    {prompt}<|im_end|>
+    <|im_start|>assistant
+    ```
+
+- Context size: `32000`
+
+- Run as LlamaEdge service
+
+  ```bash
+  wasmedge --dir .:. --nn-preload default:GGML:AUTO:Triplex-Q5_K_M.gguf \
+      llama-api-server.wasm \
+      --prompt-template chatml \
+      --ctx-size 32000 \
+      --model-name Triplex
+  ```
+
+- Run as LlamaEdge command app
+
+  ```bash
+  wasmedge --dir .:. \
+    --nn-preload default:GGML:AUTO:Triplex-Q5_K_M.gguf \
+    llama-chat.wasm \
+    --prompt-template chatml \
+    --ctx-size 32000
+  ``` -->
+
+## Quantized GGUF Models
+
+| Name | Quant method | Bits | Size | Use case |
+| ---- | ---- | ---- | ---- | ----- |
+| [Triplex-Q2_K.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q2_K.gguf)     | Q2_K   | 2 | 1.42 GB| smallest, significant quality loss - not recommended for most purposes |
+| [Triplex-Q3_K_L.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q3_K_L.gguf) | Q3_K_L | 3 | 2.09 GB| small, substantial quality loss |
+| [Triplex-Q3_K_M.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q3_K_M.gguf) | Q3_K_M | 3 | 1.96 GB| very small, high quality loss |
+| [Triplex-Q3_K_S.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q3_K_S.gguf) | Q3_K_S | 3 | 1.68 GB| very small, high quality loss |
+| [Triplex-Q4_0.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q4_0.gguf)     | Q4_0   | 4 | 2.18 GB| legacy; small, very high quality loss - prefer using Q3_K_M |
+| [Triplex-Q4_K_M.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q4_K_M.gguf) | Q4_K_M | 4 | 2.39 GB| medium, balanced quality - recommended |
+| [Triplex-Q4_K_S.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q4_K_S.gguf) | Q4_K_S | 4 | 2.19 GB| small, greater quality loss |
+| [Triplex-Q5_0.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q5_0.gguf)     | Q5_0   | 5 | 2.64 GB| legacy; medium, balanced quality - prefer using Q4_K_M |
+| [Triplex-Q5_K_M.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q5_K_M.gguf) | Q5_K_M | 5 | 2.82 GB| large, very low quality loss - recommended |
+| [Triplex-Q5_K_S.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q5_K_S.gguf) | Q5_K_S | 5 | 2.64 GB| large, low quality loss - recommended |
+| [Triplex-Q6_K.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q6_K.gguf)     | Q6_K   | 6 | 3.14 GB| very large, extremely low quality loss |
+| [Triplex-Q8_0.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-Q8_0.gguf)     | Q8_0   | 8 | 4.06 GB| very large, extremely low quality loss - not recommended |
+| [Triplex-f16.gguf](https://huggingface.co/second-state/Triplex-GGUF/blob/main/Triplex-f16.gguf)       | f16    | 16 | 7.64 GB|  |
+
+*Quantized with llama.cpp b3463*