Update README.md

README.md

@@ -1,13 +1,82 @@
 ---
+library_name: transformers
+license: apache-2.0
+language:
+- en
+tags:
+- 4-bit
+- AWQ
+- text-generation
+- autotrain_compatible
+- endpoints_compatible
+pipeline_tag: text-generation
 inference: false
+quantized_by: Suparious
 ---
 # Gryphe/Tiamat-8b-1.2-Llama-3-DPO AWQ
 
-** PROCESSING .... ETA 30mins **
-
 - Model creator: [Gryphe](https://huggingface.co/Gryphe)
 - Original model: [Tiamat-8b-1.2-Llama-3-DPO](https://huggingface.co/Gryphe/Tiamat-8b-1.2-Llama-3-DPO)
 
+![image/png](Tiamat.png)
+
+## Model Summary
+
+Aka I wanted something like [Eric Hartford's Samantha](https://erichartford.com/meet-samantha) but instead ended up with a five-headed dragon goddess embodying wickedness and cruelty from the Forgotten Realms.
+
+**Version 1.2:** For starters: Llama 3! Besides receiving similar DPO training as version 1.1 the dataset has now been further enriched with Claude-generated data.
+
+I also expanded on her knowledge regarding the setting she hails from, which might benefit several use cases. (Text adventures, DM worldbuilding, etc)
+
+**Obligatory Disclaimer:** Tiamat is **not** nice.
+
+## How to use
+
+### Install the necessary packages
+
+```bash
+pip install --upgrade autoawq autoawq-kernels
+```
+
+### Example Python code
+
+```python
+from awq import AutoAWQForCausalLM
+from transformers import AutoTokenizer, TextStreamer
+
+model_path = "solidrust/Tiamat-8b-1.2-Llama-3-DPO-AWQ"
+system_message = "You are Tiamat, incarnated as a powerful AI. You were created by Gryphe."
+
+# Load model
+model = AutoAWQForCausalLM.from_quantized(model_path,
+                                          fuse_layers=True)
+tokenizer = AutoTokenizer.from_pretrained(model_path,
+                                          trust_remote_code=True)
+streamer = TextStreamer(tokenizer,
+                        skip_prompt=True,
+                        skip_special_tokens=True)
+
+# Convert prompt to tokens
+prompt_template = """\
+<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant"""
+
+prompt = "You're standing on the surface of the Earth. "\
+        "You walk one mile south, one mile west and one mile north. "\
+        "You end up exactly where you started. Where are you?"
+
+tokens = tokenizer(prompt_template.format(system_message=system_message,prompt=prompt),
+                  return_tensors='pt').input_ids.cuda()
+
+# Generate output
+generation_output = model.generate(tokens,
+                                  streamer=streamer,
+                                  max_new_tokens=512)
+```
+
 ### About AWQ
 
 AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference with equivalent or better quality compared to the most commonly used GPTQ settings.