Skip to content

Commit

Permalink
Added documentation link to __init__.py file, per TODO comment (pytor…
Browse files Browse the repository at this point in the history
  • Loading branch information
j-dominguez9 authored and maximegmd committed Jul 13, 2024
1 parent 8283082 commit 68c9b1a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions recipes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
# 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.
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!"
"Refer to our docs for detailed instructions on how to use recipes: "
"https://pytorch.org/torchtune/main/deep_dives/recipe_deepdive.html"
)

0 comments on commit 68c9b1a

Please sign in to comment.