Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.83 KB

index.md

File metadata and controls

24 lines (17 loc) · 1.83 KB
title Developing Index
one_liner How nnspec is built and how to change it: architecture, compile and run, extending, the engine protocol, testing and contributing.
tags
developing
index
related
docs/index.md
docs/concepts/index.md

Developing Index

Up: docs/index.md — all sections.

For changing nnspec itself: read architecture first, then the page for the part you are changing.

How nnspec is built

  • architecture — How nnspec is built: the chain from document to output directory, the import direction, one concept per module, and where the code holds the five constraints that keep a document running the same everywhere.
  • compile-and-run — The two passes and the run: compile's checks with the document alone, preflight's with the model, the schedule each forward runs, how steps.run walks a plan, and what belongs to the engine.
  • engines — The engine protocol and how to add an engine: the constructor and options, what execute must do, the members steps.run and preflight read, a bound schedule site by site, where a forward stops, and where an engine refuses.

Changing it

  • extending — Adding an op, a featurizer kind, a component or a step kind: the decorator, the signature as the document's contract, where the tables come from, and the tests to add.
  • testing — Running and extending the suite: offline CPU runs at the pinned thread count, snapshot pins and re-pinning, the GPU and torchrun tests, the FORMAT drift test, the docs test, pyright, and the CI workflows that run them.
  • contributing — How changes land: branch and commit conventions, format changes with before-and-after JSON, one spelling per thing, the corpus runs unchanged, regenerating FORMAT.md, and the docs standard.