Skip to content

Move prototype to unstable #3489

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

Merged
merged 13 commits into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions .ci/docker/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ pypandoc==1.15
pandocfilters==1.5.1
markdown==3.8.2


# PyTorch Theme
-e git+https://github.com/pytorch/pytorch_sphinx_theme.git@pytorch_sphinx_theme2#egg=pytorch_sphinx_theme2

Expand Down Expand Up @@ -51,12 +50,8 @@ onnxruntime
evaluate
accelerate>=0.20.1


importlib-metadata==6.8.0

# PyTorch Theme
-e git+https://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme

ipython

sphinxcontrib.katex
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ advanced
pytorch_basics
/recipes
prototype
/unstable
sg_execution_times.rst

#data things
_data/
Expand Down
4 changes: 2 additions & 2 deletions .jenkins/download_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
BEGINNER_DATA_DIR = REPO_BASE_DIR / "beginner_source" / "data"
INTERMEDIATE_DATA_DIR = REPO_BASE_DIR / "intermediate_source" / "data"
ADVANCED_DATA_DIR = REPO_BASE_DIR / "advanced_source" / "data"
PROTOTYPE_DATA_DIR = REPO_BASE_DIR / "prototype_source" / "data"
PROTOTYPE_DATA_DIR = REPO_BASE_DIR / "unstable_source" / "data"
FILES_TO_RUN = os.getenv("FILES_TO_RUN")


Expand Down Expand Up @@ -106,7 +106,7 @@ def download_lenet_mnist() -> None:
)

def download_gpu_quantization_torchao() -> None:
# Download SAM model checkpoint for prototype_source/gpu_quantization_torchao_tutorial.py
# Download SAM model checkpoint unstable_source/gpu_quantization_torchao_tutorial.py
download_url_to_file("https://dl.fbaipublicfiles.com/segment_anything/sam_vit_h_4b8939.pth",
prefix=PROTOTYPE_DATA_DIR,
dst="sam_vit_h_4b8939.pth",
Expand Down
14 changes: 1 addition & 13 deletions .jenkins/validate_tutorials_built.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,36 +18,24 @@
"beginner_source/examples_nn/polynomial_module",
"beginner_source/examples_nn/dynamic_net",
"beginner_source/examples_nn/polynomial_optim",
"beginner_source/former_torchies/autograd_tutorial_old",
"beginner_source/former_torchies/tensor_tutorial_old",
"beginner_source/examples_autograd/polynomial_autograd",
"beginner_source/examples_autograd/polynomial_custom_function",
"intermediate_source/mnist_train_nas", # used by ax_multiobjective_nas_tutorial.py
"intermediate_source/torch_compile_conv_bn_fuser",
"intermediate_source/_torch_export_nightly_tutorial", # does not work on release
"advanced_source/usb_semisup_learn", # fails with CUDA OOM error, should try on a different worker
"prototype_source/fx_graph_mode_ptq_dynamic",
"prototype_source/vmap_recipe",
"prototype_source/torchscript_freezing",
"prototype_source/nestedtensor",
"prototype_source/gpu_direct_storage", # requires specific filesystem + GPUDirect Storage to be set up
"recipes_source/recipes/saving_and_loading_models_for_inference",
"recipes_source/recipes/saving_multiple_models_in_one_file",
"unstable_source/gpu_direct_storage", # requires specific filesystem + GPUDirect Storage to be set up
"recipes_source/recipes/tensorboard_with_pytorch",
"recipes_source/recipes/what_is_state_dict",
"recipes_source/recipes/profiler_recipe",
"recipes_source/recipes/save_load_across_devices",
"recipes_source/recipes/warmstarting_model_using_parameters_from_a_different_model",
"recipes_source/recipes/dynamic_quantization",
"recipes_source/recipes/saving_and_loading_a_general_checkpoint",
"recipes_source/recipes/benchmark",
"recipes_source/recipes/tuning_guide",
"recipes_source/recipes/zeroing_out_gradients",
"recipes_source/recipes/defining_a_neural_network",
"recipes_source/recipes/timer_quick_start",
"recipes_source/recipes/amp_recipe",
"recipes_source/recipes/Captum_Recipe",
"intermediate_source/text_to_speech_with_torchaudio",
"intermediate_source/tensorboard_profiler_tutorial", # reenable after 2.0 release.
"advanced_source/semi_structured_sparse", # reenable after 3303 is fixed.
"intermediate_source/torchrec_intro_tutorial.py", #failing with 2.8 reenable after 3498
Expand Down
20 changes: 10 additions & 10 deletions .lintrunner.toml
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ exclude_patterns = [
"intermediate_source/tiatoolbox_tutorial.rst",
"intermediate_source/torch_compile_tutorial.py",
"intermediate_source/transformer_building_blocks.py",
"prototype_source/README.md",
"prototype_source/README.txt",
"prototype_source/backend_config_tutorial.rst",
"prototype_source/gpu_direct_storage.py",
"prototype_source/inductor_cpp_wrapper_tutorial.rst",
"prototype_source/inductor_windows.rst",
"prototype_source/maskedtensor_advanced_semantics.py",
"prototype_source/max_autotune_on_CPU_tutorial.rst",
"prototype_source/vmap_recipe.py",
"unstable_source/README.md",
"unstable_source/README.txt",
"unstable_source/backend_config_tutorial.rst",
"unstable_source/gpu_direct_storage.py",
"unstable_source/inductor_cpp_wrapper_tutorial.rst",
"unstable_source/inductor_windows.rst",
"unstable_source/maskedtensor_advanced_semantics.py",
"unstable_source/max_autotune_on_CPU_tutorial.rst",
"unstable_source/vmap_recipe.py",
"recipes_source/README.txt",
"recipes_source/amx.rst",
"recipes_source/compiling_optimizer.rst",
Expand Down Expand Up @@ -150,7 +150,7 @@ exclude_patterns = [
"intermediate_source/README.txt",
"intermediate_source/TP_tutorial.rst",
"intermediate_source/inductor_debug_cpu.py",
"prototype_source/README.txt",
"unstable_source/README.txt",
"recipes_source/README.txt",
"recipes_source/recipes/README.txt",
"recipes_source/xeon_run_cpu.rst",
Expand Down
8 changes: 4 additions & 4 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@ def wrapper(*args, **kwargs):
"intermediate_source",
"advanced_source",
"recipes_source",
"prototype_source",
"unstable_source",
],
"gallery_dirs": ["beginner", "intermediate", "advanced", "recipes", "prototype"],
"gallery_dirs": ["beginner", "intermediate", "advanced", "recipes", "unstable"],
"filename_pattern": re.compile(SPHINX_SHOULD_RUN),
"promote_jupyter_magic": True,
"backreferences_dir": None,
Expand Down Expand Up @@ -202,7 +202,6 @@ def wrapper(*args, **kwargs):
html_theme_options = {
"navigation_with_keys": False,
"analytics_id": "GTM-T8XT4PS",
"pytorch_project": "tutorials",
"logo": {
"text": "",
},
Expand Down Expand Up @@ -233,6 +232,7 @@ def wrapper(*args, **kwargs):
"navbar_start": ["pytorch_version"],
"navbar_center": "navbar-nav",
"display_version": True,
"pytorch_project": "tutorials",
}

theme_variables = pytorch_sphinx_theme2.get_theme_variables()
Expand All @@ -247,7 +247,7 @@ def wrapper(*args, **kwargs):
"github_version": "main",
"doc_path": ".",
"library_links": theme_variables.get("library_links", []),
"pytorch_project": "tutorials",
#"pytorch_project": "tutorials",
}


Expand Down
4 changes: 2 additions & 2 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -831,10 +831,10 @@ Additional Resources
:maxdepth: 1
:hidden:

recipes/recipes_index
recipes_index

.. toctree::
:maxdepth: 1
:hidden:

prototype/prototype_index
unstable_index
Loading