-
Notifications
You must be signed in to change notification settings - Fork 517
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
Added documentation link to __init__.py file, per TODO comment #1056
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/1056
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit db95b95 with merge base f9cb9e6 (): This comment was automatically generated by Dr. CI and updates every 15 minutes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching and fixing this! I just had one comment.
Sorry this is a bit of a misleading TODO. The intent was to come back and add a link to the recipes page (https://pytorch.org/torchtune/main/deep_dives/recipe_deepdive.html) from within the error message itself - not the comment in the file. Can you update based on this extra context? |
Sorry about that, all set now. I didn't have any reference of style, since the other init.py files don't have these error messages, but I added the url in a new line, as requested. |
Context
What is the purpose of this PR? Is it to
Please link to any issues this PR addresses.
Changelog
What are the changes made in this PR?
Added url to documentation, per the TODO comment on recipes/init.py file.
Test plan
Please make sure to do each of the following if applicable to your PR. (If you're not sure about any one of these just ask and we will happily help.)
pre-commit install
)pytest tests
pytest tests -m integration_test