From 69951a38a428a23952c6634a5e2e1f4dbf5b0ac4 Mon Sep 17 00:00:00 2001 From: Joaquin Dominguez Date: Wed, 5 Jun 2024 14:51:30 -0400 Subject: [PATCH 1/3] Added documentation link to __init__.py file, per TODO comment --- recipes/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/recipes/__init__.py b/recipes/__init__.py index 534f5bcbb2..daee46bcfe 100644 --- a/recipes/__init__.py +++ b/recipes/__init__.py @@ -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) 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!" From 99b3bf9e2991c0fb0cdc50cc6e1f3d3482edd997 Mon Sep 17 00:00:00 2001 From: Joaquin Dominguez Date: Wed, 5 Jun 2024 16:58:38 -0400 Subject: [PATCH 2/3] updated url to reflect latest docs --- recipes/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/recipes/__init__.py b/recipes/__init__.py index daee46bcfe..dac17382e0 100644 --- a/recipes/__init__.py +++ b/recipes/__init__.py @@ -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. -# Documentation: (https://pytorch.org/torchtune/stable/index.html) +# Documentation: (https://pytorch.org/torchtune/main/index.html) 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!" From db95b9588ef5a38032a73a3822d64542a5919983 Mon Sep 17 00:00:00 2001 From: Joaquin Dominguez Date: Wed, 5 Jun 2024 20:10:06 -0400 Subject: [PATCH 3/3] included url in error message --- recipes/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/recipes/__init__.py b/recipes/__init__.py index dac17382e0..8ed6c8463e 100644 --- a/recipes/__init__.py +++ b/recipes/__init__.py @@ -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. -# Documentation: (https://pytorch.org/torchtune/main/index.html) 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" )