|
| 1 | +# Backend Documentation Template |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## Template Structure |
| 6 | + |
| 7 | +The template includes the following files: |
| 8 | + |
| 9 | +### Required Pages |
| 10 | + |
| 11 | +- `backend-overview.md` - Main backend overview and introduction |
| 12 | + |
| 13 | +### Recommended Pages |
| 14 | + |
| 15 | +- `backend-quantization.md` - Quantization support and API documentation |
| 16 | +- `backend-partitioner.md` - Partitioner API reference |
| 17 | +- `op-support.csv` - Operator support data in CSV format |
| 18 | + |
| 19 | +### Optional Pages (and Subsections) |
| 20 | + |
| 21 | +- `backend-troubleshooting.md` - Common issues and troubleshooting guide |
| 22 | +- `backend-op-support.rst` - Operator support documentation (RST format) |
| 23 | +- `backend-arch-internals.md` - Architecture and internals documentation |
| 24 | +- `tutorials/backend-tutorials.md` - Tutorial sub-section |
| 25 | + - Use this sub-section to provide tutorials for your backend. |
| 26 | + - Tutorials should explain how a user can accomplish a task, in a step by step manner. |
| 27 | + - Some examples might include: |
| 28 | + - An end to end example of lowering and running a model on a specific platform. |
| 29 | +- `tutorials/backend-guides.md` - Guides sub-section |
| 30 | + - Use this sub-section to provide guides or how-tos for backend-specific functionality. |
| 31 | + - Guides should focus on providing information and building conceptual understanding, rather than giving step by step directions. |
| 32 | + - Some examples might include: |
| 33 | + - LLM attention management / static attention |
| 34 | + - Performance optimization guide |
| 35 | + |
| 36 | +## Using the Template |
| 37 | + |
| 38 | +To use this template for a new backend: |
| 39 | + |
| 40 | +1. Copy the entire `template` directory contents to your backend's documentation directory |
| 41 | +2. Rename files to match your backend name (e.g., `backend-overview.md` → `mybackend-overview.md`) |
| 42 | +3. Populate the content for your backend. |
| 43 | + |
| 44 | +### Additional Customization |
| 45 | + |
| 46 | +You may need to: |
| 47 | +- Add backend-specific sections to any file |
| 48 | +- Remove sections that don't apply to your backend |
| 49 | +- Update the operator support CSV with your backend's supported operators |
| 50 | +- Add backend-specific images or diagrams |
| 51 | +- Update cross-references and links |
| 52 | + |
| 53 | +Try to keep the landing page (`backend-overview.md`) simple and straigtforward. Use the child pages and sections to provide more detailed information. |
0 commit comments