PocketPal AI 📱🚀

PocketPal AI is a pocket-sized AI assistant powered by small language models (SLMs) that run directly on your phone. Designed for both iOS and Android, PocketPal AI lets you interact with various SLMs without the need for an internet connection. Your privacy is fully protected as all processing happens entirely on-device — your conversations, prompts, and data never leave your phone or get stored on external servers.

Note on Privacy: The only data that may leave your device is what you explicitly choose to share: benchmark results (if you opt to contribute to the leaderboard) and any feedback you voluntarily submit through the app.

Table of Contents

• PocketPal AI 📱🚀
  • Table of Contents
  • 📰 News & Announcements
  • Features
  • Installation
    • iOS
    • Android
  • Usage
    • Downloading a Model
    • Loading a Model
    • Chatting with the model
    • Copying Text
    • Message Editing
    • Using Pals
    • Benchmarking
    • Setup Hugging Face Access Token
    • Send Feedback
  • Development Setup
    • Prerequisites
    • Getting Started
    • Scripts
  • Contributing
    • Quick Start for Contributors
  • Roadmap
  • License
  • Contact
  • Acknowledgements

📰 News & Announcements

• 🔒 HF Token Authentication (v1.9.0, Apr, 2025): Access gated models from Hugging Face with your authentication token.
• 🌐 Localization Support (v1.8.16, Apr, 2025): PocketPal AI now supports multiple languages (At the moment Japanese and Chinese).
• 📱 iPad Support (v1.8.12, Mar, 2025): Full support for iPad devices including landscape orientation.
• 👤 Pals Feature (v1.8.0, Feb, 2025): Create and chat with personalized AI assistants with different personalities.
• 🔍 Benchmarking Tool (v1.6.1, 2024): Test and compare model performance with the built-in benchmarking feature.
• 🎨 New Icon Alert (Nov 2024): PocketPal AI has a fresh new look! Huge thanks to Chun Te Lee (https://github.com/Reeray) for the design! Read more (https://github.com/a-ghorbani/pocketpal-ai/discussions/102).
• 🚀 Hugging Face Public Hub Integration (v1.5, Nov 2024): PocketPal AI now integrates with the Hugging Face model Hub! Browse, download, and run models directly from the Hugging Face Hub within the app. Read more (https://github.com/a-ghorbani/pocketpal-ai/discussions/104)

Features

• Offline AI Assistance: Run language models directly on your device without internet connectivity.
• Model Flexibility: Download and swap between multiple SLMs, including Danube 2 and 3, Phi, Gemma 2, and Qwen.
• Auto Offload/Load: Automatically manage memory by offloading models when the app is in the background.
• Inference Settings: Customize model parameters like system prompt, temperature, BOS token, and chat templates.
• Real-Time Performance Metrics: View tokens per second and milliseconds per token during AI response generation.
• Message Editing: Edit your messages and retry AI generation.
• Personalized Pals: Create different AI personalities with customized settings.
• Background Downloads: Continue downloading models while using other apps (iOS).
• Screen Awake During Inference: Keep your screen on while the AI is generating responses.
• Multi-device Support: Optimized for both phones and tablets, including iPad.
• Localization: Use the app in your preferred language.
• Hugging Face Integration: Access both public and gated models with authentication.

Installation

iOS

Download PocketPal AI from the App Store:

Download on the App Store (https://apps.apple.com/us/app/pocketpal-ai/id6502579498)

Android

Get PocketPal AI on Google Play:

Get it on Google Play (https://play.google.com/store/apps/details?id=com.pocketpalai)

Usage

Downloading a Model

1. Open the app and tap the Menu icon (☰).
2. Navigate to the Models page.
3. Choose a model from the list and tap Download.
4. Or tap the + button to add models from Hugging Face or locally downloaded ones.
5. If you select "Add from Hugging Face", you can search GGUF models directly on HF and select any quantization that fits your device (memory and storage).
6. You can then download it immediately or bookmark it for later.