Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,95 @@
 ---
-license: apache-2.0
+base_model: OuteAI/OuteTTS-0.3-1B
+license: cc-by-nc-4.0
+model_creator: OuteAI
+model_name: OuteTTS-0.3-1B
+quantized_by: Second State Inc.
+language:
+- en
+- zh
+- ja
+- ko
+- fr
+- de
+pipeline_tag: text-to-speech
 ---
+
+<!-- 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 -->
+
+# OuteTTS-0.3-1B-GGUF
+
+## Original Model
+
+[OuteAI/OuteTTS-0.3-1B](https://huggingface.co/OuteAI/OuteTTS-0.3-1B)
+
+## Run with LlamaEdge
+
+- LlamaEdge version: coming soon
+
+<!-- - LlamaEdge version: [v0.14.3](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.14.3) and above -->
+
+<!-- - 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: `8192`
+
+- Run as LlamaEdge service
+
+  ```bash
+  wasmedge --dir .:. --nn-preload default:GGML:AUTO:OuteTTS-0.3-1B-Q5_K_M.gguf \
+    llama-api-server.wasm \
+    --model-name OuteTTS-0.3-1B \
+    --prompt-template llama-3-chat \
+    --ctx-size 8192
+  ```
+
+- Run as LlamaEdge command app
+
+  ```bash
+  wasmedge --dir .:. --nn-preload default:GGML:AUTO:OuteTTS-0.3-1B-Q5_K_M.gguf \
+    llama-chat.wasm \
+    --prompt-template llama-3-chat \
+    --ctx-size 8192
+  ``` -->
+
+## Quantized GGUF Models
+
+| Name | Quant method | Bits | Size | Use case |
+| ---- | ---- | ---- | ---- | ----- |
+| [OuteTTS-0.3-1B-Q2_K.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q2_K.gguf)     | Q2_K   | 2 | 491 MB| smallest, significant quality loss - not recommended for most purposes |
+| [OuteTTS-0.3-1B-Q3_K_L.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q3_K_L.gguf) | Q3_K_L | 3 | 663 MB| small, substantial quality loss |
+| [OuteTTS-0.3-1B-Q3_K_M.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q3_K_M.gguf) | Q3_K_M | 3 | 616 MB| very small, high quality loss |
+| [OuteTTS-0.3-1B-Q3_K_S.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q3_K_S.gguf) | Q3_K_S | 3 | 560 MB| very small, high quality loss |
+| [OuteTTS-0.3-1B-Q4_0.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q4_0.gguf)     | Q4_0   | 4 | 702 MB| legacy; small, very high quality loss - prefer using Q3_K_M |
+| [OuteTTS-0.3-1B-Q4_K_M.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q4_K_M.gguf) | Q4_K_M | 4 | 745 MB| medium, balanced quality - recommended |
+| [OuteTTS-0.3-1B-Q4_K_S.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q4_K_S.gguf) | Q4_K_S | 4 | 709 MB| small, greater quality loss |
+| [OuteTTS-0.3-1B-Q5_0.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q5_0.gguf)     | Q5_0   | 5 | 836 MB| legacy; medium, balanced quality - prefer using Q4_K_M |
+| [OuteTTS-0.3-1B-Q5_K_M.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q5_K_M.gguf) | Q5_K_M | 5 | 859 MB| large, very low quality loss - recommended |
+| [OuteTTS-0.3-1B-Q5_K_S.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q5_K_S.gguf) | Q5_K_S | 5 | 836 MB| large, low quality loss - recommended |
+| [OuteTTS-0.3-1B-Q6_K.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q6_K.gguf)     | Q6_K   | 6 | 979 MB| very large, extremely low quality loss |
+| [OuteTTS-0.3-1B-Q8_0.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-Q8_0.gguf)     | Q8_0   | 8 | 1.27 GB| very large, extremely low quality loss - not recommended |
+| [OuteTTS-0.3-1B-f16.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/OuteTTS-0.3-1B-f16.gguf)       | f16    | 16 | 2.38 GB| |
+| [wavtokenizer-large-75-ggml-f16.gguf](https://huggingface.co/second-state/OuteTTS-0.3-1B-GGUF/blob/main/wavtokenizer-large-75-ggml-f16.gguf)       | f16    | 16 | 1.00 GB| |
+
+*Quantized with llama.cpp b4497*