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

Added documentation link to __init__.py file, per TODO comment #1056

Merged
merged 3 commits into from
Jun 6, 2024
Merged

Added documentation link to __init__.py file, per TODO comment #1056

merged 3 commits into from
Jun 6, 2024

Conversation

j-dominguez9
Copy link
Contributor

Context

What is the purpose of this PR? Is it to

  • add a new feature
  • fix a bug
  • [ X] update tests and/or documentation
  • other (please add here)

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.)

  • run pre-commit hooks and linters (make sure you've first installed via pre-commit install)
  • add unit tests for any new functionality
  • update docstrings for any new or updated methods or classes
  • run unit tests via pytest tests
  • run recipe tests via pytest tests -m integration_test
  • manually run any new or modified recipes with sufficient proof of correctness
    • include relevant commands and any other artifacts in this summary (pastes of loss curves, eval results, etc.)

Copy link

pytorch-bot bot commented Jun 5, 2024

🔗 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 Failures

As of commit db95b95 with merge base f9cb9e6 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 5, 2024
Copy link
Contributor

@RdoubleA RdoubleA left a 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.

recipes/__init__.py Outdated Show resolved Hide resolved
@joecummings
Copy link
Contributor

joecummings commented Jun 5, 2024

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?

@j-dominguez9
Copy link
Contributor Author

j-dominguez9 commented Jun 5, 2024

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.

@joecummings joecummings merged commit 161ac3d into pytorch:main Jun 6, 2024
29 checks passed
maximegmd pushed a commit to maximegmd/torchtune that referenced this pull request Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants