Closed dlwh closed 11 months ago
This is still WIP, but I want to share it out, so we can align on the format and structure: https://github.com/stanford-crfm/levanter/pull/135
Ideally, we can write such descriptions inside the class, and then populate the documentation with some documentation library for Python, like HuggingFace does: https://huggingface.co/transformers/v3.0.2/main_classes/trainer.html
i think you meant to put this comment in stanford-crfm/levanter#123
There are doc comments in config.py actually. I guess I was thinking of something a bit higher level that gave you the most important ones or something, i dunno. Maybe the right way to do this is a guide to running training on something nontrivial ?
I have a branch with a doc generator. I'll push now
The overview + code isn't enough. We need a proper doc site.