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.

Sign up for GitHub

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69951a3
Added documentation link to __init__.py file, per TODO comment
j-dominguez9 Jun 5, 2024
99b3bf9
updated url to reflect latest docs
j-dominguez9 Jun 5, 2024
db95b95
included url in error message
j-dominguez9 Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion recipes/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Since we don't want the tests to to incorrectly assume that recipes are
# importable, we have to explicitly raise an error here.

# TODO: Add proper link to pytorch.org/torchtune/... when the docs are live.
# Documentation: (https://pytorch.org/torchtune/stable/index.html)
j-dominguez9 marked this conversation as resolved.
Show resolved Hide resolved
raise ModuleNotFoundError(
"The torchtune recipes directory isn't a package and you should not import anything from here. "
"Refer to our docs for detailed instructions on how to use recipes!"
Expand Down