Create README.md

README.md

@@ -0,0 +1,108 @@
+---
+license: cc-by-nc-4.0
+tags:
+  - mobile-o
+  - multimodal
+  - unified-model
+  - ios
+  - coreml
+  - mlx
+  - on-device
+  - mobile
+  - edge-ai
+pipeline_tag: image-text-to-text
+---
+
+<div align="center">
+
+<h1>
+  <img src="https://github.com/Amshaker/Mobile-O/blob/main/assets/mobile-o-logo.png?raw=true" width="30" /> Mobile-O-0.5B-iOS
+</h1>
+
+**Optimized MLX & CoreML Components for On-Device Deployment**
+
+<p>
+<a href="https://arxiv.org/abs/XXXX.XXXXX"><img src="https://img.shields.io/badge/arXiv-XXXX.XXXXX-b31b1b.svg" alt="arXiv"></a>
+<a href="https://github.com/Amshaker/Mobile-O"><img src="https://img.shields.io/badge/GitHub-Code-black.svg" alt="Code"></a>
+<a href="https://amshaker.github.io/Mobile-O/"><img src="https://img.shields.io/badge/🌐-Project_Page-2563eb.svg" alt="Project Page"></a>
+<a href="https://mobileo.cvmbzuai.com/"><img src="https://img.shields.io/badge/🚀-Live_Demo-10b981.svg" alt="Demo"></a>
+<a href="https://apps.apple.com/app/XXXXXXXXXX"><img src="https://img.shields.io/badge/-App_Store-black.svg" alt="App Store"></a>
+</p>
+
+</div>
+
+## 📌 Overview
+
+This repository contains the optimized **MLX** and **CoreML** model components of [Mobile-O-0.5B](https://huggingface.co/Amshaker/Mobile-O-0.5B) for native iOS deployment. These components power the [Mobile-O iOS app](https://github.com/Amshaker/Mobile-O/tree/main/Mobile-O-App), enabling fully on-device multimodal understanding and image generation with no cloud dependency.
+
+## 📱 On-Device Performance
+
+| Spec | Detail |
+|------|--------|
+| ⚡ Image Generation | ~3 seconds |
+| 👁️ Visual Understanding | ~0.4 seconds |
+| 💾 Memory Footprint | < 2GB |
+| 📱 Compatible Devices | iPhone (A17+ / M-series) |
+| 🔒 Cloud Dependency | None — fully on-device |
+
+## 📦 Contents
+
+This repo includes optimized model components in both **MLX** and **CoreML** formats:
+
+| Component | Format | Description |
+|-----------|--------|-------------|
+| **VLM** | MLX / CoreML | FastVLM-0.5B (FastViT + Qwen2-0.5B) |
+| **Diffusion Decoder** | MLX / CoreML | SANA-600M-512 (Linear DiT + VAE) |
+| **MCP** | MLX / CoreML | Mobile Conditioning Projector (~2.4M params) |
+
+## 🚀 Usage
+
+### With the iOS App
+
+1. Clone the [Mobile-O repo](https://github.com/Amshaker/Mobile-O)
+2. Navigate to the `Mobile-O-App/` directory
+3. Download this model repo into the app's model directory
+4. Build and run in Xcode
+
+```bash
+git clone https://github.com/Amshaker/Mobile-O.git
+cd Mobile-O/Mobile-O-App
+```
+
+Refer to the [Mobile-O-App README](https://github.com/Amshaker/Mobile-O/tree/main/Mobile-O-App) for detailed setup instructions.
+
+### Download Models
+
+```python
+from huggingface_hub import snapshot_download
+
+snapshot_download(
+    repo_id="Amshaker/Mobile-O-0.5B-iOS",
+    repo_type="model",
+    local_dir="ios_models"
+)
+```
+
+## 🔗 Related Resources
+
+| Resource | Link |
+|----------|------|
+| 🤗 Mobile-O-0.5B | [PyTorch Model](https://huggingface.co/Amshaker/Mobile-O-0.5B) |
+| 🤗 Mobile-O-1.5B | [PyTorch Model](https://huggingface.co/Amshaker/Mobile-O-1.5B) |
+| 📱 iOS App Source Code | [Mobile-O-App](https://github.com/Amshaker/Mobile-O/tree/main/Mobile-O-App) |
+| 🤗 Training Datasets | [Collection](https://huggingface.co/collections/Amshaker/mobile-o-datasets) |
+
+## 📄 Citation
+
+```bibtex
+@article{shaker2026mobileo,
+  title={Mobile-O: Unified Multimodal Understanding and Generation on Mobile Device},
+  author={Shaker, Abdelrahman and Heakl, Ahmed and Muhammad, Jaseel and Thawkar, Ritesh and Thawakar, Omkar and Li, Senmao and Cholakkal, Hisham and Reid, Ian and Xing, Eric P. and Khan, Salman and Khan, Fahad Shahbaz},
+  journal={arXiv preprint arXiv:XXXX.XXXXX},
+  year={2026}
+}
+```
+
+## ⚖️ License
+
+Released under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/). For research purposes only.