Upload README.md

README.md

@@ -0,0 +1,42 @@
+---
+language:
+- en
+tags:
+- falcon3
+- falcon3_mamba
+- falcon_mamba
+- mlx
+base_model: tiiuae/Falcon3-Mamba-7B-Instruct
+license: other
+license_name: falcon-llm-license
+license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
+library_name: transformers
+---
+
+# mlx-community/Falcon3-Mamba-7B-Instruct-4bits
+
+The Model [mlx-community/Falcon3-Mamba-7B-Instruct-4bits](https://huggingface.co/mlx-community/Falcon3-Mamba-7B-Instruct-4bits) was
+converted to MLX format from [tiiuae/Falcon3-Mamba-7B-Instruct](https://huggingface.co/tiiuae/Falcon3-Mamba-7B-Instruct)
+using mlx-lm version **0.20.2**.
+
+## Use with mlx
+
+```bash
+pip install mlx-lm
+```
+
+```python
+from mlx_lm import load, generate
+
+model, tokenizer = load("mlx-community/Falcon3-Mamba-7B-Instruct-4bits")
+
+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)
+```