Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,38 @@
+---
+license: apache-2.0
+language:
+- en
+base_model: LatitudeGames/Wayfarer-12B
+tags:
+- text adventure
+- roleplay
+- mlx
+- mlx-my-repo
+library_name: transformers
+---
+
+# mrfakename/Wayfarer-12B-Q4-mlx
+
+The Model [mrfakename/Wayfarer-12B-Q4-mlx](https://huggingface.co/mrfakename/Wayfarer-12B-Q4-mlx) was converted to MLX format from [LatitudeGames/Wayfarer-12B](https://huggingface.co/LatitudeGames/Wayfarer-12B) 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("mrfakename/Wayfarer-12B-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)
+```