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

Recipe documentation #2050

Open
joecummings opened this issue Nov 22, 2024 · 1 comment
Open

Recipe documentation #2050

joecummings opened this issue Nov 22, 2024 · 1 comment

Comments

@joecummings
Copy link
Contributor

  1. Add recipe documentation to torchtune
  2. Remove docstrings from recipe classes
  3. Profit

cc @SalmanMohammadi

@felipemello1
Copy link
Contributor

I am not sure if i like it. If the documentation stays close to the code, its easier to keep it updated and understand whats going on. Moving elsewhere means that users may not know it exists and they may get out of sync. I am happy to be convinced otherwise, but usually, i prefer to generate documentation from code.

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

2 participants