Skip to content

docs: add cookbook with practical SATE AI recipes (Issue #42) - #85

Open
assassinaj602 wants to merge 10 commits into
mainfrom
feature/docs-cookbook
Open

docs: add cookbook with practical SATE AI recipes (Issue #42)#85
assassinaj602 wants to merge 10 commits into
mainfrom
feature/docs-cookbook

Conversation

@assassinaj602

Copy link
Copy Markdown
Owner

Description

Adds a practical SATE AI cookbook with comprehensive recipes and integration guides for testing on-device AI models.

Related Issue

Closes #42

Changes

New Documentation & Recipes

  • Landing page & navigation: docs/cookbook/index.md & docs/cookbook/README.md
  • Recipe 1: Testing Chatbot Models (docs/cookbook/recipe-1-chatbot-testing.md) - Llama/Phi/Gemma under KV-cache memory pressure & bad prompts
  • Recipe 2: Testing Image Classifiers (docs/cookbook/recipe-2-image-classifier-testing.md) - MobileNet/ResNet under thermal throttling & latency delays
  • Recipe 3: Testing Speech-to-Text Models (docs/cookbook/recipe-3-speech-to-text-testing.md) - Audio buffer framing & confidence thresholds
  • Recipe 4: Testing with ONNX Runtime (docs/cookbook/recipe-4-onnx-runtime-testing.md) - Asset validation, dynamic shapes & OnnxAdapter
  • Recipe 5: Testing with TensorFlow Lite (docs/cookbook/recipe-5-tflite-testing.md) - Quantization drift & GPU delegate fallback
  • Common setup & helpers: docs/cookbook/common-setup.md & docs/cookbook/examples/cookbook_helper.dart
  • Integration guide & summary: docs/cookbook/integration-guide.md & docs/cookbook/SUMMARY.md
  • Main README: Added Cookbook section with direct navigation links

PR Checklist

- Add docs/cookbook/ directory
- Create index.md as landing page
- Set up structure for recipe documentation
- Part of #42
- Add comprehensive overview of SATE AI cookbook
- Include recipe list with brief descriptions
- Add navigation links between recipes
- Explain prerequisites and setup
- Part of #42
- Document testing Llama/Phi/Gemma models for conversational AI
- Include code examples for MemoryPressure, MalformedInput, QuantizationDrift
- Show expected graceful degradation under memory pressure
- Add setup instructions and troubleshooting
- Part of #42
- Document testing MobileNet/ResNet models for image classification
- Include code examples for ThermalThrottle, Latency, ModelSwap
- Show expected behavior during CPU throttling
- Add performance benchmarks and visualization tips
- Part of #42
- Document testing on-device speech recognition models
- Include code examples for MalformedInput, Latency, ConfidenceThreshold
- Show input validation and confidence handling
- Add audio preprocessing tips
- Part of #42
- Document using OnnxAdapter with real ONNX models
- Include loading models from assets and running stress tests
- Show all injectors working with ONNX models
- Add ONNX-specific configuration tips
- Part of #42
- Document using TFLiteAdapter with real TFLite models
- Include loading from assets and stress testing
- Show all injectors working with TFLite models
- Add TFLite delegate configuration notes
- Part of #42
- Add Cookbook section to main README
- Include brief description and link to docs/cookbook/
- Highlight practical use cases covered
- Improve documentation discoverability
- Part of #42
- Add common setup guide for all recipes
- Include reusable code snippets and utilities
- Add sample model loading functions
- Create examples directory with helper scripts
- Part of #42
- Add integration guide for combining multiple injectors
- Create SUMMARY.md for documentation navigation
- Add cross-references between recipes
- Include best practices and performance tips
- Finalize cookbook for #42
Closes #42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add cookbook with practical SATE AI recipes

1 participant