Merge branch 'main' into add-new-theme

Author: svekars

.jenkins/validate_tutorials_built.py

@@ -53,8 +53,6 @@
     "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", # reenable after 3302 is fixe
-    "intermediate_source/memory_format_tutorial", # causes other tutorials like torch_logs fail. "state" issue, reseting dynamo didn't help
-    "intermediate_source/ax_multiobjective_nas_tutorial"
 ]
 
 def tutorial_source_dirs() -> List[Path]:

conf.py

@@ -34,24 +34,66 @@
 
 html_theme = "pytorch_sphinx_theme2"
 html_theme_path = [pytorch_sphinx_theme2.get_html_theme_path()]
-import distutils.file_util
-import gc
+
+import torch
 import glob
 import random
-import re
 import shutil
-from pathlib import Path
-
 import numpy
 import pandocfilters
 import plotly.io as pio
 import pypandoc
 import torch
-
+import distutils.file_util
+import re
 from get_sphinx_filenames import SPHINX_SHOULD_RUN
+import pandocfilters
+import pypandoc
+import plotly.io as pio
+from pathlib import Path
 
 pio.renderers.default = "sphinx_gallery"
 
+import sphinx_gallery.gen_rst
+import multiprocessing
+
+# Monkey patch sphinx gallery to run each example in an isolated process so that
+# we don't need to worry about examples changing global state.
+#
+# Alt option 1: Parallelism was added to sphinx gallery (a later version that we
+# are not using yet) using joblib, but it seems to result in errors for us, and
+# it has no effect if you set parallel = 1 (it will not put each file run into
+# its own process and run singly) so you need parallel >= 2, and there may be
+# tutorials that cannot be run in parallel.
+#
+# Alt option 2: Run sphinx gallery once per file (similar to how we shard in CI
+# but with shard sizes of 1), but running sphinx gallery for each file has a
+# ~5min overhead, resulting in the entire suite taking ~2x time
+def call_fn(func, args, kwargs, result_queue):
+    try:
+        result = func(*args, **kwargs)
+        result_queue.put((True, result))
+    except Exception as e:
+        result_queue.put((False, str(e)))
+
+def call_in_subprocess(func):
+    def wrapper(*args, **kwargs):
+        result_queue = multiprocessing.Queue()
+        p = multiprocessing.Process(
+            target=call_fn,
+            args=(func, args, kwargs, result_queue)
+        )
+        p.start()
+        p.join()
+        success, result = result_queue.get()
+        if success:
+            return result
+        else:
+            raise RuntimeError(f"Error in subprocess: {result}")
+    return wrapper
+
+sphinx_gallery.gen_rst.generate_file_rst = call_in_subprocess(sphinx_gallery.gen_rst.generate_file_rst)
+
 try:
     import torchvision
 except ImportError:
@@ -109,43 +151,19 @@
 # -- Sphinx-gallery configuration --------------------------------------------
 
 
-def reset_seeds(gallery_conf, fname):
-    torch.cuda.empty_cache()
-    torch.backends.cudnn.deterministic = True
-    torch.backends.cudnn.benchmark = False
-    torch._dynamo.reset()
-    torch._inductor.config.force_disable_caches = True
-    torch.manual_seed(42)
-    torch.set_default_device(None)
-    random.seed(10)
-    numpy.random.seed(10)
-    torch.set_grad_enabled(True)
-
-    gc.collect()
-
-
 sphinx_gallery_conf = {
-    "examples_dirs": [
-        "beginner_source",
-        "intermediate_source",
-        "advanced_source",
-        "recipes_source",
-        "prototype_source",
-    ],
-    "gallery_dirs": ["beginner", "intermediate", "advanced", "recipes", "prototype"],
-    "filename_pattern": re.compile(SPHINX_SHOULD_RUN),
-    "promote_jupyter_magic": True,
-    "backreferences_dir": None,
-    "first_notebook_cell": (
-        "# For tips on running notebooks in Google Colab, see\n"
-        "# https://pytorch.org/tutorials/beginner/colab\n"
-        "%matplotlib inline"
-    ),
-    "reset_modules": (reset_seeds),
-    "ignore_pattern": r"_torch_export_nightly_tutorial.py",
-    "pypandoc": {
-        "extra_args": ["--mathjax", "--toc"],
-        "filters": [".jenkins/custom_pandoc_filter.py"],
+    'examples_dirs': ['beginner_source', 'intermediate_source',
+                      'advanced_source', 'recipes_source', 'prototype_source'],
+    'gallery_dirs': ['beginner', 'intermediate', 'advanced', 'recipes', 'prototype'],
+    'filename_pattern': re.compile(SPHINX_SHOULD_RUN),
+    'promote_jupyter_magic': True,
+    'backreferences_dir': None,
+    'first_notebook_cell': ("# For tips on running notebooks in Google Colab, see\n"
+                            "# https://pytorch.org/tutorials/beginner/colab\n"
+                            "%matplotlib inline"),
+    'ignore_pattern': r'_torch_export_nightly_tutorial.py',
+    'pypandoc': {'extra_args': ['--mathjax', '--toc'],
+                 'filters': ['.jenkins/custom_pandoc_filter.py'],
     },
 }