README.md

GPUFabric Documentation

Complete documentation for the GPUFabric Android SDK project.

📚 Documentation Index

🚀 Getting Started

• Quick Start Guide - Setup and build in 5 minutes

🔧 Android Development

• Android Development Guide - Android-specific notes and development checklist
• Android x86_64 Deployment Guide - Multi-platform deployment

🏗️ Architecture & Design

• Build Guide - Complete build system documentation
• Initialization Guide - System initialization procedures
• Inference Service Architecture - Service design and patterns

📊 Model Management

• Model Management Guide - Model loading and management
• Model Status Examples - Practical model usage examples

🔌 API Reference

• API Documentation - Low-level API reference
• Mobile Integration - Mobile-specific APIs

📈 Platform Guides

• Platform Guides - Cross-platform compatibility
• Platform Documentation - Platform-specific details

🔄 Advanced Features

• Compute Sharing Diagrams - Resource sharing architecture
• Offline Mode Guide - Offline inference capabilities
• Streaming API Guide - Token callback streaming APIs and examples

🔗 P2P

• Example client: ../examples/p2p_sdk_client.rs

📊 Architecture Diagrams

• SDK Compute Sharing Flow - Resource flow visualization
• SDK Compute Sharing Sequence - Sequence diagrams

🎯 Android Development Focus

📱 Android Platform Support

• ✅ ARM64: Full functionality with real llama.cpp API
• ⚠️ x86_64: Compatibility layer API for development and testing

Core Android Documents

Document	Description	Use Case
ANDROID_X86_64_DEPLOYMENT_GUIDE.md	x86_64 deployment guide	Emulator development and testing

🏗️ Build Scripts Location

Build scripts are located in the project root and scripts/:

• ../generate_sdk.sh - Main SDK generation script
• ../compile_android.sh - Android build helper
• ../scripts/test_android_inference.sh - Android on-device inference test

📖 Usage Guidelines

1. Production Deployment: Refer to ANDROID_X86_64_DEPLOYMENT_GUIDE.md
2. Development Checklist: Refer to mobile/ANDROID_DEVELOPMENT_GUIDE.md

🎯 Quick Navigation

For Android Developers

1. Start with Quick Start Guide
2. Read Android Development Guide
3. Follow Streaming API Guide

For System Architects

1. Study Inference Service Architecture
2. Explore Compute Sharing Diagrams
3. Review Initialization Guide

For Model Engineers

1. Read Model Management Guide
2. Check Model Status Examples
3. Review Offline Mode Guide

---

💡 Tip: Most guides include practical examples and code snippets. Start with the Quick Start Guide for hands-on experience.