Create more extensive docs
Open
@vdplasthijs is already working on this.
Since Jun 16, 2026.
documentation
- Dominant language
- Python
- Stars
- 8
- Forks
- 2
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 5
Description
The readme does a great job for setting up / running a simple training loop. Some things are still missing, for example how to implement a new dataset. Perhaps it would be good to write the docs with several 'use cases' in mind:
- Inference on an existing model.
- Further training an existing model.
- Implementing a new dataset/use case.
- ..?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.