edge-gallery/README.md
2025-06-03 11:44:56 +07:00

90 lines
6.2 KiB
Markdown

# Google AI Edge Gallery ✨
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/google-ai-edge/gallery)](https://github.com/google-ai-edge/gallery/releases)
[![Platform](https://img.shields.io/badge/Platform-Android%20%7C%20iOS%20(soon)-lightgrey)](https://github.com/google-ai-edge/gallery)
**Unlock the power of on-device Generative AI! The Google AI Edge Gallery is your experimental playground to explore, experience, and evaluate cutting-edge AI models—running entirely offline, directly on your Android device (iOS support coming soon).**
Dive into a world of creative and practical AI: chat with advanced models, get insights from your images, experiment with prompts, and see real-time performance. All this, without needing an internet connection once models are downloaded.
---
## 🚀 What Can You Do?
The Gallery showcases a variety of on-device AI capabilities:
| **Overview & Model Selection** | **Visual Q&A (Ask Image)** |
| :-----------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: |
| <img width="600" alt="Overview" src="https://github.com/user-attachments/assets/4f2702d7-91a0-4eb3-aa76-58bc8e7089c6" /> | <img width="600" alt="Ask Image" src="https://github.com/user-attachments/assets/e2b5b41b-fed0-4a7c-9547-2abb1c10962c" /> |
| **Explore available models and dive into different AI experiences.** | **Upload an image and ask questions about it, get descriptions, or identify objects.** |
| **Prompt Lab (Single-Turn LLM)** | **AI Chat (Multi-Turn Conversation)** |
| :-------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: |
| <img width="600" alt="Prompt Lab" src="https://github.com/user-attachments/assets/22e459d0-0365-4a92-8570-fb59d4d1e320" /> | <img width="600" alt="AI Chat" src="https://github.com/user-attachments/assets/edaa4f89-237a-4b84-b647-b3c4631f09dc" /> |
| **Summarize text, rewrite content, generate code, or use freeform prompts.** | **Engage in dynamic, multi-turn conversations with an AI.** |
***Suggestion: Consider creating a short GIF showcasing these features in action and embedding it here for a more dynamic preview!***
---
## ✨ Core Features
* **📱 Run Locally, Fully Offline:** Experience the magic of Generative AI without an internet connection. All processing happens directly on your device, ensuring privacy and speed.
* **🤖 Diverse Model Zoo:** Easily switch between different foundation models (e.g., from Hugging Face) and compare their performance and capabilities.
* **🖼️ Visual Question Answering (Ask Image):** Go beyond simple object detection. Upload an image and ask complex questions, get detailed descriptions, or solve visual puzzles.
* **✍️ Creative Prompting (Prompt Lab):** A sandbox for your ideas! Summarize articles, rewrite paragraphs, generate code snippets, or explore other single-turn LLM use cases.
* **💬 Conversational AI (AI Chat):** Engage in fluid, multi-turn conversations. Explore the model's reasoning, memory, and conversational abilities.
* **📊 Real-time Performance Insights:** Monitor key metrics like Time To First Token (TTFT), decode speed (tokens/sec), and overall latency to understand model efficiency on your device.
* **🧩 Bring Your Own Model (BYOM):** Advanced users can easily test their own local LiteRT `.task` models.
* **🔗 Developer-Focused Resources:** Quick access to model cards, source code, and relevant documentation.
---
## 🏁 Get Started in Minutes!
1. **Download the App:** Grab the latest `ai-edge-gallery.apk` from our [**Releases Page**](https://github.com/google-ai-edge/gallery/releases/latest).
2. **Install & Explore:**
* Enable installation from unknown sources on your Android device.
* Install the APK.
* Launch the app and download your first model!
3. **Need Help?** For detailed installation instructions (including for corporate devices) and a full user guide, head over to our [**Project Wiki**](https://github.com/google-ai-edge/gallery/wiki).
---
## 🛠️ Technology Powering the Gallery
This app leverages Google's cutting-edge on-device ML technologies:
* **Google AI Edge:** The core suite of APIs and tools enabling powerful on-device machine learning.
* **LiteRT (MediaPipe GenAI):** A lightweight, high-performance runtime optimized for executing Generative AI models directly on mobile devices.
* **LLM Inference API:** Specifically designed for running Large Language Models efficiently on-device, powering features like chat and prompt lab.
* **Hugging Face Integration:** Seamlessly discover, download, and utilize a wide range of pre-trained models from the Hugging Face Hub.
---
## 🤝 We Value Your Feedback!
This is an **experimental Alpha release**, and your input is crucial for shaping its future.
* 🐞 **Found a bug?** Help us improve by [**reporting it here**](https://github.com/google-ai-edge/gallery/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D).
* 💡 **Have an idea or feature request?** We'd love to hear it! [**Suggest it here**](https://github.com/google-ai-edge/gallery/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D).
* 🤔 **Questions or discussions?** Join the conversation on our [**Discussions Tab**](https://github.com/google-ai-edge/gallery/discussions) (if enabled) or raise an issue.
---
## 📄 License
Licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
---
## 🔗 Useful Links
* [**Project Wiki (User Guides & FAQs)**](https://github.com/google-ai-edge/gallery/wiki)
* [LLM Inference guide for Android (Google AI Edge Docs)](https://ai.google.dev/edge/mediapipe/solutions/genai/llm_inference/android)
* [Google AI Edge Documentation](https://ai.google.dev/edge)
* [Hugging Face LiteRT Community](https://huggingface.co/litert-community) (for discovering compatible models)
---
**Made with ❤️ by the Google AI Edge Team.**