stanford-crfm / haliax

Named Tensors for Legible Deep Learning in JAX
Apache License 2.0
141 stars 9 forks source link

Make Haliax docs #4

Closed dlwh closed 11 months ago

dlwh commented 1 year ago

The overview + code isn't enough. We need a proper doc site.

Ivan-Zhou commented 1 year 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

Ivan-Zhou commented 1 year ago

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

dlwh commented 1 year ago

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

dlwh commented 1 year ago

https://github.com/stanford-crfm/levanter/compare/mkdocs?expand=1