Skip to content

Commit 8cbb100

Browse files
author
Svetlana Karslioglu
authored
Merge branch 'main' into add-issue-template-2
2 parents d416f27 + 3ba83fa commit 8cbb100

File tree

4 files changed

+59
-48
lines changed

4 files changed

+59
-48
lines changed

‎.jenkins/get_sphinx_filenames.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
from pathlib import Path
2+
from typing import List
3+
4+
from get_files_to_run import get_all_files
5+
from validate_tutorials_built import NOT_RUN
6+
7+
8+
def get_files_for_sphinx() -> List[str]:
9+
all_py_files = get_all_files()
10+
return [x for x in all_py_files if all(y not in x for y in NOT_RUN)]
11+
12+
13+
SPHINX_SHOULD_RUN = "|".join(get_files_for_sphinx())

‎.jenkins/validate_tutorials_built.py

Lines changed: 43 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,47 @@
99
# the file name to explain why, like intro.html), or fix the tutorial and remove it from this list).
1010

1111
NOT_RUN = [
12-
"basics/intro", # no code
13-
"translation_transformer",
14-
"profiler",
15-
"saving_loading_models",
16-
"introyt/captumyt",
17-
"examples_nn/polynomial_module",
18-
"examples_nn/dynamic_net",
19-
"examples_nn/polynomial_optim",
20-
"former_torchies/autograd_tutorial_old",
21-
"former_torchies/tensor_tutorial_old",
22-
"examples_autograd/polynomial_autograd",
23-
"examples_autograd/polynomial_custom_function",
24-
"parametrizations",
25-
"mnist_train_nas", # used by ax_multiobjective_nas_tutorial.py
26-
"fx_conv_bn_fuser",
27-
"super_resolution_with_onnxruntime",
28-
"ddp_pipeline", # requires 4 gpus
29-
"fx_graph_mode_ptq_dynamic",
30-
"vmap_recipe",
31-
"torchscript_freezing",
32-
"nestedtensor",
33-
"recipes/saving_and_loading_models_for_inference",
34-
"recipes/saving_multiple_models_in_one_file",
35-
"recipes/loading_data_recipe",
36-
"recipes/tensorboard_with_pytorch",
37-
"recipes/what_is_state_dict",
38-
"recipes/profiler_recipe",
39-
"recipes/save_load_across_devices",
40-
"recipes/warmstarting_model_using_parameters_from_a_different_model",
41-
"torch_compile_tutorial_",
42-
"recipes/dynamic_quantization",
43-
"recipes/saving_and_loading_a_general_checkpoint",
44-
"recipes/benchmark",
45-
"recipes/tuning_guide",
46-
"recipes/zeroing_out_gradients",
47-
"recipes/defining_a_neural_network",
48-
"recipes/timer_quick_start",
49-
"recipes/amp_recipe",
50-
"recipes/Captum_Recipe",
51-
"flask_rest_api_tutorial",
52-
"text_to_speech_with_torchaudio",
12+
"beginner_source/basics/intro", # no code
13+
"beginner_source/translation_transformer",
14+
"beginner_source/profiler",
15+
"beginner_source/saving_loading_models",
16+
"beginner_source/introyt/captumyt",
17+
"beginner_source/examples_nn/polynomial_module",
18+
"beginner_source/examples_nn/dynamic_net",
19+
"beginner_source/examples_nn/polynomial_optim",
20+
"beginner_source/former_torchies/autograd_tutorial_old",
21+
"beginner_source/former_torchies/tensor_tutorial_old",
22+
"beginner_source/examples_autograd/polynomial_autograd",
23+
"beginner_source/examples_autograd/polynomial_custom_function",
24+
"intermediate_source/parametrizations",
25+
"intermediate_source/mnist_train_nas", # used by ax_multiobjective_nas_tutorial.py
26+
"intermediate_source/fx_conv_bn_fuser",
27+
"advanced_source/super_resolution_with_onnxruntime",
28+
"advanced_source/ddp_pipeline", # requires 4 gpus
29+
"prototype_source/fx_graph_mode_ptq_dynamic",
30+
"prototype_source/vmap_recipe",
31+
"prototype_source/torchscript_freezing",
32+
"prototype_source/nestedtensor",
33+
"recipes_source/recipes/saving_and_loading_models_for_inference",
34+
"recipes_source/recipes/saving_multiple_models_in_one_file",
35+
"recipes_source/recipes/loading_data_recipe",
36+
"recipes_source/recipes/tensorboard_with_pytorch",
37+
"recipes_source/recipes/what_is_state_dict",
38+
"recipes_source/recipes/profiler_recipe",
39+
"recipes_source/recipes/save_load_across_devices",
40+
"recipes_source/recipes/warmstarting_model_using_parameters_from_a_different_model",
41+
"intermediate_source/torch_compile_tutorial_",
42+
"recipes_source/recipes/dynamic_quantization",
43+
"recipes_source/recipes/saving_and_loading_a_general_checkpoint",
44+
"recipes_source/recipes/benchmark",
45+
"recipes_source/recipes/tuning_guide",
46+
"recipes_source/recipes/zeroing_out_gradients",
47+
"recipes_source/recipes/defining_a_neural_network",
48+
"recipes_source/recipes/timer_quick_start",
49+
"recipes_source/recipes/amp_recipe",
50+
"recipes_source/recipes/Captum_Recipe",
51+
"intermediate_source/flask_rest_api_tutorial",
52+
"intermediate_source/text_to_speech_with_torchaudio",
5353
]
5454

5555

@@ -67,6 +67,7 @@ def main() -> None:
6767
glob_path = f"{tutorial_source_dir}/**/*.html"
6868
html_file_paths += docs_dir.glob(glob_path)
6969

70+
should_not_run = [f'{x.replace("_source", "")}.html' for x in NOT_RUN]
7071
did_not_run = []
7172
for html_file_path in html_file_paths:
7273
with open(html_file_path, "r", encoding="utf-8") as html_file:
@@ -77,9 +78,7 @@ def main() -> None:
7778
if (
7879
"Total running time of the script: ( 0 minutes 0.000 seconds)"
7980
in elem.text
80-
and not any(
81-
html_file_path.match(file) for file in NOT_RUN
82-
)
81+
and not any(html_file_path.match(file) for file in should_not_run)
8382
):
8483
did_not_run.append(html_file_path.as_posix())
8584

‎beginner_source/basics/tensorqs_tutorial.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
######################################################################
134134
# **Joining tensors** You can use ``torch.cat`` to concatenate a sequence of tensors along a given dimension.
135135
# See also `torch.stack <https://pytorch.org/docs/stable/generated/torch.stack.html>`__,
136-
# another tensor joining op that is subtly different from ``torch.cat``.
136+
# another tensor joining option that is subtly different from ``torch.cat``.
137137
t1 = torch.cat([tensor, tensor, tensor], dim=1)
138138
print(t1)
139139

‎conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
from custom_directives import IncludeDirective, GalleryItemDirective, CustomGalleryItemDirective, CustomCalloutItemDirective, CustomCardItemDirective
3939
import distutils.file_util
4040
import re
41-
from validate_tutorials_built import NOT_RUN
41+
from get_sphinx_filenames import SPHINX_SHOULD_RUN
4242

4343
import plotly.io as pio
4444
pio.renderers.default = 'sphinx_gallery'
@@ -87,8 +87,7 @@
8787
'examples_dirs': ['beginner_source', 'intermediate_source',
8888
'advanced_source', 'recipes_source', 'prototype_source'],
8989
'gallery_dirs': ['beginner', 'intermediate', 'advanced', 'recipes', 'prototype'],
90-
'filename_pattern': '.py',
91-
'ignore_pattern': re.compile(f"({'|'.join(NOT_RUN)}).py$"),
90+
'filename_pattern': re.compile(SPHINX_SHOULD_RUN),
9291
'promote_jupyter_magic': True,
9392
'backreferences_dir': None
9493
}

0 commit comments

Comments
 (0)