Update README.md

README.md

@@ -5,3 +5,138 @@ pipeline_tag: image-text-to-text
 tags:
 - mlx
 ---
+
+
+
+## Use with mlx
+
+Install the required library:
+
+```bash
+pip install -U mlx-vlm
+```
+
+> **Model Note:** `Zenith-9B-CodeCore-Merge` is a 9-billion parameter multimodal coding model designed for code generation, visual debugging, repository reasoning, and architecture diagram analysis. It supports both text and image/screenshot inputs.
+
+### BF16 Variant (Base Weights)
+
+The full-precision BF16 files reside directly in the root of the repository:
+
+#### CLI (Terminal)
+
+```bash
+python -m mlx_vlm generate \
+  --model prithivMLmods/Zenith-9B-CodeCore-Merge-MLX \
+  --max-tokens 512 \
+  --temperature 0.0 \
+  --prompt "Analyze this code screenshot, explain what it does, and fix any potential bugs or edge cases." \
+  --image <path_to_image>
+```
+
+#### Python API
+
+```python
+from mlx_vlm import load, generate
+from mlx_vlm.prompt_utils import apply_chat_template
+from mlx_vlm.utils import load_config
+
+model_path = "prithivMLmods/Zenith-9B-CodeCore-Merge-MLX"
+model, processor = load(model_path)
+config = load_config(model_path)
+
+image = ["<path_to_image>"]
+prompt = "Analyze this code screenshot, explain what it does, and fix any potential bugs or edge cases."
+formatted_prompt = apply_chat_template(processor, config, prompt, num_images=len(image))
+
+output = generate(
+    model, 
+    processor, 
+    formatted_prompt, 
+    image=image, 
+    max_tokens=512, 
+    temperature=0.0
+)
+print(output.text)
+```
+
+### 8-bit Variant
+
+Target the `8bit` subfolder:
+
+#### CLI (Terminal)
+
+```bash
+python -m mlx_vlm generate \
+  --model prithivMLmods/Zenith-9B-CodeCore-Merge-MLX/8bit \
+  --max-tokens 512 \
+  --temperature 0.0 \
+  --prompt "Analyze this code screenshot, explain what it does, and fix any potential bugs or edge cases." \
+  --image <path_to_image>
+```
+
+#### Python API
+
+```python
+from mlx_vlm import load, generate
+from mlx_vlm.prompt_utils import apply_chat_template
+from mlx_vlm.utils import load_config
+
+model_path = "prithivMLmods/Zenith-9B-CodeCore-Merge-MLX"
+model, processor = load(model_path, subfolder="8bit")
+config = load_config(model_path, subfolder="8bit")
+
+image = ["<path_to_image>"]
+prompt = "Analyze this code screenshot, explain what it does, and fix any potential bugs or edge cases."
+formatted_prompt = apply_chat_template(processor, config, prompt, num_images=len(image))
+
+output = generate(
+    model, 
+    processor, 
+    formatted_prompt, 
+    image=image, 
+    max_tokens=512, 
+    temperature=0.0
+)
+print(output.text)
+```
+
+### 4-bit Variant
+
+Target the `4bit` subfolder:
+
+#### CLI (Terminal)
+
+```bash
+python -m mlx_vlm generate \
+  --model prithivMLmods/Zenith-9B-CodeCore-Merge-MLX/4bit \
+  --max-tokens 512 \
+  --temperature 0.0 \
+  --prompt "Analyze this code screenshot, explain what it does, and fix any potential bugs or edge cases." \
+  --image <path_to_image>
+```
+
+#### Python API
+
+```python
+from mlx_vlm import load, generate
+from mlx_vlm.prompt_utils import apply_chat_template
+from mlx_vlm.utils import load_config
+
+model_path = "prithivMLmods/Zenith-9B-CodeCore-Merge-MLX"
+model, processor = load(model_path, subfolder="4bit")
+config = load_config(model_path, subfolder="4bit")
+
+image = ["<path_to_image>"]
+prompt = "Analyze this code screenshot, explain what it does, and fix any potential bugs or edge cases."
+formatted_prompt = apply_chat_template(processor, config, prompt, num_images=len(image))
+
+output = generate(
+    model, 
+    processor, 
+    formatted_prompt, 
+    image=image, 
+    max_tokens=512, 
+    temperature=0.0
+)
+print(output.text)
+```