Roughly ninety pages, ported from the library's own repository.
These pages are generated from the library's documentation rather than written here, so they move when it moves. Each one says which version it describes, and a page describing an older version says so at the top instead of leaving you to find out.
Start somewhere
- Start here
Have not installed it yet
- Tutorials
Installed it, and want one worked example end to end
- Refusal reference
Hit a refusal and do not know what it means
- API reference
Know what you want and need the signature
What is in here
- Getting started 2
- Tutorials 3
- How-to guides 16
- Models & signals 9
- Instruments 22
- Training loops 5
- Concepts 7
- The measurement discipline 9
- When it refuses 1
- The sciences 1
- Interpreting results honestly 1
- What 3.0 does not do 1
- Background & theory 6
- Command line 1
- API reference 14
- Coming from v1.0 1
- Contributing 1
How to read these pages
- Every page says which library version it describes. A page describing an older version carries a banner naming it, because a documentation page that is quietly a release behind is worse than one that is loudly two.
- Every page can be copied as markdown, and has a plain-markdown twin at the same path. A fair number of readers hand these pages to a language model, and a page that copies as styled HTML is a page that arrives as noise.
- Refusals are values rather than errors. They are blue, they carry a remedy, and there are seventeen of them. Refusal reference