Google Git
Sign in
android/platform/external/executorch/refs/heads/upstream-main/./docs/source/backends/template
tree: 631a849486258a201649c4300a14c40e2738af1d [path history] [tgz]
  1. guides/
  2. tutorials/
  3. backend-arch-internals.md
  4. backend-overview.md
  5. backend-partitioner.rst
  6. backend-quantization.md
  7. backend-troubleshooting.md
  8. op-support.csv
  9. README.md
docs/source/backends/template/README.md

Backend Documentation Template

This template provides a standardized structure and starting point for backend documentation. It is intended to provide a uniform experience for users while allowing for backends to customize their documentation as needed.

Template Structure

The template includes the following files:

Required Pages

  • backend-overview.md - Main backend overview and introduction

Recommended Pages

  • backend-quantization.md - Quantization support and API documentation
  • backend-partitioner.md - Partitioner API reference
  • op-support.csv - Operator support data in CSV format

Optional Pages (and Subsections)

  • backend-troubleshooting.md - Common issues and troubleshooting guide
  • backend-op-support.rst - Operator support documentation (RST format)
  • backend-arch-internals.md - Architecture and internals documentation
  • tutorials/backend-tutorials.md - Tutorial sub-section
    • Use this sub-section to provide tutorials for your backend.
    • Tutorials should explain how a user can accomplish a task, in a step by step manner.
    • Some examples might include:
      • An end to end example of lowering and running a model on a specific platform.
  • tutorials/backend-guides.md - Guides sub-section
    • Use this sub-section to provide guides or how-tos for backend-specific functionality.
    • Guides should focus on providing information and building conceptual understanding, rather than giving step by step directions.
    • Some examples might include:
      • LLM attention management / static attention
      • Performance optimization guide

Using the Template

To use this template for a new backend:

  1. Copy the entire template directory contents to your backend's documentation directory
  2. Rename files to match your backend name (e.g., backend-overview.md → mybackend-overview.md)
  3. Populate the content for your backend.

Additional Customization

You may need to:

  • Add backend-specific sections to any file
  • Remove sections that don't apply to your backend
  • Update the operator support CSV with your backend's supported operators
  • Add backend-specific images or diagrams
  • Update cross-references and links

Try to keep the landing page (backend-overview.md) simple and straigtforward. Use the child pages and sections to provide more detailed information.