Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,60 @@
+---
+language:
+- en
+license: llama3
+tags:
+- Llama-3
+- instruct
+- finetune
+- chatml
+- gpt4
+- synthetic data
+- distillation
+- function calling
+- json mode
+- axolotl
+- roleplaying
+- chat
+- mlx
+- mlx-my-repo
+base_model: NousResearch/Hermes-3-Llama-3.2-3B
+widget:
+- example_title: Hermes 3
+  messages:
+  - role: system
+    content: You are a sentient, superintelligent artificial general intelligence,
+      here to teach and assist me.
+  - role: user
+    content: Write a short story about Goku discovering kirby has teamed up with Majin
+      Buu to destroy the world.
+library_name: transformers
+model-index:
+- name: Hermes-3-Llama-3.2-3B
+  results: []
+---
+
+# CuckmeisterFuller/Hermes-3-Llama-3.2-3B-Q4-mlx
+
+The Model [CuckmeisterFuller/Hermes-3-Llama-3.2-3B-Q4-mlx](https://huggingface.co/CuckmeisterFuller/Hermes-3-Llama-3.2-3B-Q4-mlx) was converted to MLX format from [NousResearch/Hermes-3-Llama-3.2-3B](https://huggingface.co/NousResearch/Hermes-3-Llama-3.2-3B) using mlx-lm version **0.20.5**.
+
+## Use with mlx
+
+```bash
+pip install mlx-lm
+```
+
+```python
+from mlx_lm import load, generate
+
+model, tokenizer = load("CuckmeisterFuller/Hermes-3-Llama-3.2-3B-Q4-mlx")
+
+prompt="hello"
+
+if hasattr(tokenizer, "apply_chat_template") and tokenizer.chat_template is not None:
+    messages = [{"role": "user", "content": prompt}]
+    prompt = tokenizer.apply_chat_template(
+        messages, tokenize=False, add_generation_prompt=True
+    )
+
+response = generate(model, tokenizer, prompt=prompt, verbose=True)
+```