Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Epic][Improvement] Add module and function docs #373

Open
JamesKunstle opened this issue Dec 16, 2024 · 0 comments
Open

[Epic][Improvement] Add module and function docs #373

JamesKunstle opened this issue Dec 16, 2024 · 0 comments

Comments

@JamesKunstle
Copy link
Contributor

We don't currently document the functions or modules in this library aside from our single main entrypoints. It'd be nice if users could take advantage of some of our libraries optimizations even if they're not using our training loop (e.g. multipack sampling).

We could do this manually, or we could use a docstring-based doc rendering solution like Sphinx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant