Create README.md

README.md

@@ -0,0 +1,127 @@
+---
+language:
+- en
+tags:
+- android
+- on-device
+- litert
+- llm
+- gemma
+- qwen
+- phi
+- nanochat
+license: other
+---
+
+# NanoChat — On-Device Model Mirror
+
+This repository hosts the quantized **LiteRT** model files used by **[NanoChat](https://github.com/adiagarwalrock/NanoChat)** — a free, open-source Android app that runs large language models fully on-device, with no internet connection required after the initial download and no API keys needed.
+
+All models are mirrored here from their original sources so that NanoChat users on the Play Store can download them without needing a Hugging Face account.
+
+---
+
+## 📱 About NanoChat
+
+NanoChat brings powerful, private AI chat to your Android phone. Everything runs locally on your device — your conversations never leave your phone.
+
+- 🔒 **Fully private** — no data ever sent to any server
+- ⚡ **Fast** — GPU-accelerated inference via Google's LiteRT runtime
+- 📦 **No account or API key required** — models download directly in-app
+- 🖼️ **Multimodal** — select models support image and audio input
+- 🆓 **Free and open source**
+
+**→ [View NanoChat on GitHub](https://github.com/adiagarwalrock/NanoChat)**
+
+---
+
+## 🗂️ Repository Structure
+
+Each model lives in its own folder:
+
+```
+nanochat-models/
+├── Gemma3-1B-IT/
+│   └── gemma3-1b-it-int4.litertlm
+├── Gemma-3n-E2B-it/
+│   └── gemma-3n-E2B-it-int4.litertlm
+├── Gemma-3n-E4B-it/
+│   └── gemma-3n-E4B-it-int4.litertlm
+├── MobileActions-270M/
+│   └── mobile_actions_q8_ekv1024.litertlm
+├── Phi-4-mini-instruct/
+│   └── Phi-4-mini-instruct_multi-prefill-seq_q8_ekv4096.litertlm
+├── Qwen2.5-1.5B-Instruct/
+│   └── Qwen2.5-1.5B-Instruct_multi-prefill-seq_q8_ekv4096.litertlm
+├── Qwen3.5-0.8B-Instruct/
+│   └── model_multimodal.litertlm
+├── Qwen3.5-2B-Instruct/
+│   └── model_multimodal.litertlm
+├── Qwen3.5-4B-Instruct/
+│   └── model_multimodal.litertlm
+└── TinyGarden-270M/
+    └── tiny_garden_q8_ekv1024.litertlm
+```
+
+---
+
+## 🤖 Available Models
+
+### 💬 Chat Models
+
+| Model | Size | Min RAM | Vision | Audio |
+|---|---|---|---|---|
+| Gemma3-1B-IT | 558 MB | 6 GB | ❌ | ❌ |
+| Qwen2.5-1.5B-Instruct | 1.49 GB | 6 GB | ❌ | ❌ |
+| Qwen3.5-0.8B-Instruct | 1.16 GB | 4 GB | ✅ | ❌ |
+| Qwen3.5-2B-Instruct | 2.78 GB | 8 GB | ✅ | ❌ |
+| Gemma-3n-E2B-it | 3.40 GB | 8 GB | ✅ | ✅ |
+| Phi-4-mini-instruct | 3.81 GB | 8 GB | ❌ | ❌ |
+| Qwen3.5-4B-Instruct | 5.26 GB | 8 GB | ✅ | ❌ |
+| Gemma-3n-E4B-it *(experimental)* | 4.58 GB | 12 GB | ✅ | ✅ |
+
+### 🛠️ Specialised Models
+
+| Model | Size | Purpose |
+|---|---|---|
+| TinyGarden-270M | 276 MB | Tiny Garden game |
+| MobileActions-270M | 276 MB | On-device mobile actions |
+
+---
+
+## 📥 Original Sources
+
+| Model | Original Repo |
+|---|---|
+| Gemma3-1B-IT | [litert-community/Gemma3-1B-IT](https://huggingface.co/litert-community/Gemma3-1B-IT) |
+| Qwen2.5-1.5B-Instruct | [litert-community/Qwen2.5-1.5B-Instruct](https://huggingface.co/litert-community/Qwen2.5-1.5B-Instruct) |
+| Qwen3.5-0.8B-Instruct | [litert-community/Qwen3.5-0.8B-LiteRT](https://huggingface.co/litert-community/Qwen3.5-0.8B-LiteRT) |
+| Qwen3.5-2B-Instruct | [litert-community/Qwen3.5-2B-LiteRT](https://huggingface.co/litert-community/Qwen3.5-2B-LiteRT) |
+| Qwen3.5-4B-Instruct | [litert-community/Qwen3.5-4B-LiteRT](https://huggingface.co/litert-community/Qwen3.5-4B-LiteRT) |
+| Gemma-3n-E2B-it | [google/gemma-3n-E2B-it-litert-lm](https://huggingface.co/google/gemma-3n-E2B-it-litert-lm) |
+| Gemma-3n-E4B-it | [google/gemma-3n-E4B-it-litert-lm](https://huggingface.co/google/gemma-3n-E4B-it-litert-lm) |
+| Phi-4-mini-instruct | [litert-community/Phi-4-mini-instruct](https://huggingface.co/litert-community/Phi-4-mini-instruct) |
+| TinyGarden-270M | [litert-community/functiongemma-270m-ft-tiny-garden](https://huggingface.co/litert-community/functiongemma-270m-ft-tiny-garden) |
+| MobileActions-270M | [litert-community/functiongemma-270m-ft-mobile-actions](https://huggingface.co/litert-community/functiongemma-270m-ft-mobile-actions) |
+
+---
+
+## ⚖️ Licenses
+
+| Model Family | License |
+|---|---|
+| Gemma 3, Gemma 3n, TinyGarden, MobileActions | [Gemma Terms of Use](https://ai.google.dev/gemma/terms) |
+| Qwen 2.5, Qwen 3.5 | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) |
+| Phi-4-mini | [MIT](https://opensource.org/licenses/MIT) |
+
+> By downloading Gemma-family models through NanoChat you agree to the [Gemma Terms of Use](https://ai.google.dev/gemma/terms).
+
+---
+
+## 🔄 Keeping This Mirror Updated
+
+This mirror is synced from the NanoChat [`model_allowlist`](https://github.com/adiagarwalrock/NanoChat) whenever a new version ships. Only `enabled` models are mirrored. Disabled models are not uploaded but existing files are never deleted, ensuring backwards compatibility with older app versions.
+
+---
+
+*Built with ❤️ for the NanoChat community.*