edge-gallery/README.md
2025-05-19 14:02:15 -07:00

64 lines
3.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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)
**Explore, Experience, and Evaluate the Future of On-Device Generative AI with Google AI Edge.**
The Google AI Edge Gallery is an experimental app that puts the power of cutting-edge Generative AI models directly into your hands, running entirely on your Android *(available now)* and iOS *(coming soon)* devices. Discover what's possible, today!
## 🚀 What is Google AI Edge Gallery?
Google AI Edge Gallery is your interactive playground for on-device AI. It's built to:
* **Inspire Developers:** See what you can build with Google AI Edge.
* **Showcase Capabilities:** Experience the performance and quality of LiteRT-optimized models.
* **Reduce Friction:** Easily try out different models and tasks without writing code.
* **Foster Community:** An open-source project for learning.
## ✨ Core Features
* **📱 On-Device GenAI:** Run LLMs locally fast, private, and offline-capable.
* **🤖 Diverse Model Zoo:** Explore models from the Hugging Face LiteRT Community and Google.
* **✍️ Prompt Lab:** Summarize, rewrite, generate code, or use freeform prompts to explore single-turn LLM use cases.
* **💬 AI Chat:** Engage in multi-turn conversations.
* **📊 Performance Insights:** Real-time benchmarks (TTFT, decode speed, latency).
* **🧩 Bring Your Own Model:** Test your local LiteRT `.task` models.
* **🔗 Developer Resources:** Quick links to model cards and source code.
<!-- Insert a compelling GIF showcasing the app in action. See “Drive folder for Images” tab:. -->
<!--
<p align="center">
<img src="docs/images/app_demo.gif" alt="AI Edge Gallery Demo" width="600"/>
</p>
-->
## 🏁 Get Started in Minutes!
1. **Download the App:** Grab the [latest APK](https://github.com/google-ai-edge/gallery/releases/latest/download/ai-edge-gallery.apk).
2. **Install & Explore:** 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 Highlights
* **Google AI Edge:** Core APIs and tools for on-device ML.
* **LiteRT:** Lightweight runtime for optimized model execution.
* **LLM Inference API:** Powering on-device Large Language Models.
* **Hugging Face Integration:** For model discovery and download.
## 🤝 Feedback
This is an **experimental Alpha release**, and your input is crucial!
* 🐞 **Found a bug?** [Report it here!](https://github.com/google-ai-edge/gallery/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D)
* 💡 **Have an idea?** [Suggest a feature!](https://github.com/google-ai-edge/gallery/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D)
## 📄 License
Licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
## 🔗 Useful Links
* [**Project Wiki (Detailed Guides)**](https://github.com/google-ai-edge/gallery/wiki)
* [Hugging Face LiteRT Community](https://huggingface.co/litert-community)
* [LLM Inference guide for Android](https://ai.google.dev/edge/mediapipe/solutions/genai/llm_inference/android)
* [Google AI Edge Documentation](https://ai.google.dev/edge)