# Raptor documentation

Start with the [build and quick start](../README.md). Commands in these guides
run from the repository root unless stated otherwise.

## Compiler

- [Architecture, compilation pipeline, source layout, and simulator tests](compiler/architecture.md)
- [Pim compiler options and defaults](compiler/options.md)
- [Spatial physical layouts and compatibility matrix](compiler/spatial-layouts.md)
- [Scheduling ownership, costs, capacity, and complexity](compiler/scheduling.md)
- [Scheduling implementation contracts and model limitations](compiler/scheduling-implementation.md)

## Evaluation

- [Measurement methodology and canonical result datasets](evaluation/methodology.md)
- [Pimcomp operation support, standalone reproduction, and GA controls](evaluation/pimcomp-reproducibility.md)
- [Validation commands and defaults](../validation/README.md)
- [Pimcomp comparison and plotting](../validation/tools/pim/pimcomp/compare/README.md)
- [Raptor ablation and plotting](../validation/tools/pim/ablation/README.md)
- [Pimcomp correctness experiments](../validation/tools/pim/pimcomp/correctness/README.md)

## Component references

- [Operation suite](../validation/operations/README.md) and [all 177 cases](../validation/operations/INVENTORY.md)
- [Comparison models, provenance, checksums, and hardware profiles](../validation/networks/pimcomp_models/README.md)
- [Graph Explorer usage](../tools/raptor_graph_explorer/README.md) and [architecture/API](../tools/raptor_graph_explorer/ARCHITECTURE.md)

## Normative engineering contracts

These contracts stay in `.agents/invariants/`; general documentation links to
them rather than restating their requirements:

- [Graph compute batch fragments](../.agents/invariants/GRAPH_COMPUTE_BATCH_INVARIANT.md)
- [Compiler performance](../.agents/invariants/PERFORMANCE_OPTIMIZATION_INVARIANT.md)
- [Pimsim performance oracle](../.agents/invariants/PIMSIM_NN_ORACLE_INVARIANT.md)
- [PIM synchronization](../.agents/invariants/PIM_SYNCHRONIZATION_INVARIANT.md)
- [Pipeline scheduling](../.agents/invariants/PIPELINE_SCHEDULING_INVARIANT.md)
- [Spatial target generality](../.agents/invariants/SPATIAL_TARGET_GENERALITY_INVARIANT.md)