PTO ISA Documentation Guide¶

This page is the main documentation entry for PTO Tile Lib. It helps readers locate documents by topic instead of navigating directories one by one.

The PTO documentation mainly covers the following areas:

• ISA fundamentals and an overall reading path
• Instruction indexes and per-instruction reference pages
• Tile programming model, event synchronization, and performance tuning
• Getting started, test execution, and documentation build instructions

Recommended Reading Path¶

If you are new to PTO Tile Lib, we recommend reading in the following order:

1. Getting Started: set up the environment and run the CPU simulator first
2. ISA Overview: build an overall understanding of the PTO ISA
3. PTO Instruction List: browse the standard operations by category
4. Tile Programming Model: understand tile shape, tile mask, and data organization
5. Events and Synchronization: understand set/wait flag usage and pipeline synchronization
6. Performance Optimization: understand common bottlenecks and tuning directions

Documentation Categories¶

1. ISA and Instruction Reference¶

• Virtual ISA Manual Entry: top-level entry for the PTO ISA manual
• ISA Overview: background, goals, and overall structure of the PTO ISA
• PTO Instruction List: index of PTO standard operations organized by category
• General Conventions: common naming rules, constraints, and usage conventions

2. Programming Model and Development Notes¶

• Development Documentation Index: entry for developer-facing PTO Tile Lib documentation
• Tile Programming Model: tile shape, tile mask, and data layout
• Events and Synchronization: event recording, waiting, and synchronization behavior
• Performance Optimization: performance analysis and tuning guidance
• CostModel Backends (stub / fit): backend split, formula-fit path, and run guide

3. Getting Started, Testing, and Documentation Build¶

• Getting Started: environment setup and CPU / NPU execution guide
• Test Guide: test entry points, scripts, and common commands
• Documentation Build Guide: how to build the docs locally with MkDocs

4. Other Related Documents¶

• Machine Documentation: abstract machine model and related notes

Directory Structure¶

Key entries are listed below:

├── isa/                        # PTO instruction reference and category indexes
├── coding/                     # Programming model, development, and optimization docs
├── auto_mode/                  # Auto Mode related documents
├── machine/                    # Abstract machine model documents
├── mkdocs/                     # Documentation site build config and scripts
├── figures/                    # Images and diagram assets used in docs
├── README*                     # Documentation entry pages
├── PTOISA*                     # ISA overview documents
└── getting-started*            # Getting started guides

Related Entry Points¶

• Root README: project overview, quick start, and repository entry page
• kernels Directory Guide: kernel and operator implementation entry point
• include Directory Guide: headers and public interface overview
• tests Directory Guide: testing and execution entry point