Developer documentation
Maintain working model callbacks, reproducible experiment records and portable trained artifacts. This section covers contributor and maintainer tasks; the public interfaces belong in Reference.
Prerequisites
For library work, use a supported Python environment and the extras required by the affected framework. Follow CONTRIBUTING for the checkout and test commands. Documentation-site work additionally needs Node.js 20 or later and npm; it does not require a training framework.
Choose the task
| Task | Canonical route | Expected proof |
|---|---|---|
| Change library behavior | Contributing | Focused regression coverage, relevant framework lane and distribution checks |
| Update frameworks or archive contracts | Maintenance | Current, minimum and legacy compatibility; fresh-process recovery |
| Author or restructure documentation | Documentation system | Source-backed prose, exhaustive routes, runnable examples and full site checks |
| Change visual treatment | Documentation style | Measured desktop/mobile previews, keyboard access, light/dark contrast |
| Build and inspect the documentation site | Site operation | Locked installation, audit, build, local search and browser proof |
| Inspect merge contracts and gate settings | Configuration | Law/configuration/snapshot agreement and measured ratchets |
| Assess supply-chain and trust boundaries | Security assurance case | Exact candidate, audit, artifact and live-setting evidence |
| Review OpenSSF evidence and remaining criteria | OpenSSF evidence | Current public score, complete coverage, signed release and human confirmation |
| Inspect distributions | Packaging | Reproducible builds, complete source archive and installed-wheel checks |
| Prepare an authorized release | Making a release | Reviewed version, matching notes, explicit release and provenance |
| Choose the compatibility bump | Semantic versioning | Python/CLI/schema/archive impact and matching metadata |
| Change public documentation strings | Writing docstrings | Caller meaning and no new measured debt |
| Review accepted limitations | Technical debt | Current evidence and explicit repair conditions |
| Activate external governance | Repository setup | Installed live protection, least-privilege audit and release setup |
| Participate in the project | Code of conduct | The stated community expectations |
Review boundary
Document runtime behavior from the implementation and tests. A prose change must not quietly change a model callback, manifest field, output default or archive format. Example execution proves code behavior; the site build proves rendering and route behavior. Keep those results separate in review evidence.
Before accepting a dependency update, run the affected framework and recovery checks from Maintenance. Before accepting a documentation change, run the commands in Documentation system. A failure in either surface blocks its own acceptance; successful rendering does not excuse a failed training example.
Read next
Start with Contributing for a code change or Site operation for a documentation change.