Where to go next¶
For: someone who has finished the five tutorials and now has a task in mind. Two minutes.
You can install AdaptShot, teach it from a folder of photographs, read every part of its answer, correct it, and save it. Everything from here on is organised by what you want to do, not by what there is to know.
I have a task¶
The how-to guides are one page per task, written for someone who has done the tutorials and does not need them repeated:
- Run the demo with the wifi switched off — for showing it to someone else
- Check what a machine can do — before committing an afternoon to it
- Choose the promise level (α) — and how many photographs it needs
- Save, load and migrate a learner
- Fine-tune from corrections — the optional deeper adjustment, with the PyTorch extra
- Use a different backbone, export one to ONNX
- Run the benchmarks — reproduce every published number
- Use Tambua, the web application built on AdaptShot
- Deploy offline, troubleshoot
I want to understand why¶
The Understand section explains the design and its trade-offs:
- How it works — the pipeline from photograph to answer, in one page
- The guarantee — exactly what the prediction set promises, when it holds, and where it stops holding, with the measurements
- Why CPU-only and offline
- Algorithm theory, for the mathematics
- The technical note — two pages, every number traceable
I need the exact details¶
The Reference: every public name, classified as stable or experimental; every configuration field; every error and what it means; what each results file contains.
I want to contribute¶
Start with Contributing and the development setup. The five-stage validation gate, the API stability policy, how these documentation pages are tested, and how a release happens are each their own page. Every code block in the tutorials and how-tos is executed by the test suite on every change; if you find one that does not run, that is a bug worth reporting.