[docs] Remove empty code blocks (#13689)

This removes the linter that checks that each sphinx gallery tutorial begins with the proper boilerplate by extracting it out to sphinx gallery reset functions. This runs automatically so no code in the tutorials nor associated linters are necessary.
apache · Jan 12, 2023 · 665dd41 · 665dd41
1 parent e0c2181
commit 665dd41
Show file tree

Hide file tree

Showing 74 changed files with 24 additions and 533 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -223,6 +223,10 @@ def rewrite_generic_admonition(match):
     return text
 
 
+def install_request_hook(gallery_conf, fname):
+    testing.utils.install_request_hook(depth=3)
+
+
 INSTALL_TVM_DEV = f"""\
 %%shell
 # Installs the latest dev build of TVM from PyPI. If you wish to build
@@ -431,6 +435,7 @@ def jupyter_notebook(script_blocks, gallery_conf, target_dir, real_func):
     "topic/vta/tutorials",
 ]
 
+
 subsection_order = ExplicitOrder(
     str(p)
     for p in [
@@ -563,6 +568,7 @@ def force_gc(gallery_conf, fname):
     "expected_failing_examples": [],
     "reset_modules": ("matplotlib", "seaborn", force_gc),
     "promote_jupyter_magic": True,
+    "reset_modules": (install_request_hook),
 }
 
 autodoc_default_options = {

diff --git a/gallery/how_to/compile_models/from_coreml.py b/gallery/how_to/compile_models/from_coreml.py
@@ -34,11 +34,6 @@
 https://github.com/apple/coremltools
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 import tvm
 from tvm import te
 import tvm.relay as relay

diff --git a/gallery/how_to/compile_models/from_darknet.py b/gallery/how_to/compile_models/from_darknet.py
@@ -32,12 +32,6 @@
 
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 # numpy and matplotlib
 import numpy as np
 import matplotlib.pyplot as plt

diff --git a/gallery/how_to/compile_models/from_keras.py b/gallery/how_to/compile_models/from_keras.py
@@ -37,9 +37,6 @@
 
 # sphinx_gallery_start_ignore
 # sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
 # sphinx_gallery_end_ignore
 import tvm
 from tvm import te

diff --git a/gallery/how_to/compile_models/from_mxnet.py b/gallery/how_to/compile_models/from_mxnet.py
@@ -33,13 +33,10 @@
 https://mxnet.apache.org/versions/master/install/index.html
 """
 
+# some standard imports
 # sphinx_gallery_start_ignore
 # sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
 # sphinx_gallery_end_ignore
-# some standard imports
 import mxnet as mx
 import tvm
 import tvm.relay as relay

diff --git a/gallery/how_to/compile_models/from_oneflow.py b/gallery/how_to/compile_models/from_oneflow.py
@@ -39,9 +39,6 @@
 
 # sphinx_gallery_start_ignore
 # sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
 # sphinx_gallery_end_ignore
 import os, math
 from matplotlib import pyplot as plt

diff --git a/gallery/how_to/compile_models/from_onnx.py b/gallery/how_to/compile_models/from_onnx.py
@@ -32,11 +32,6 @@
 https://github.com/onnx/onnx
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 import onnx
 import numpy as np
 import tvm

diff --git a/gallery/how_to/compile_models/from_paddle.py b/gallery/how_to/compile_models/from_paddle.py
@@ -31,11 +31,6 @@
 https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/pip/linux-pip.html
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 import tarfile
 import paddle
 import numpy as np

diff --git a/gallery/how_to/compile_models/from_pytorch.py b/gallery/how_to/compile_models/from_pytorch.py
@@ -41,12 +41,6 @@
 be unstable.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 import tvm
 from tvm import relay
 

diff --git a/gallery/how_to/compile_models/from_tensorflow.py b/gallery/how_to/compile_models/from_tensorflow.py
@@ -29,12 +29,6 @@
 Please refer to https://www.tensorflow.org/install
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 # tvm, relay
 import tvm
 from tvm import te

diff --git a/gallery/how_to/compile_models/from_tflite.py b/gallery/how_to/compile_models/from_tflite.py
@@ -56,12 +56,6 @@
 # Utils for downloading and extracting zip files
 # ----------------------------------------------
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 import os
 
 

diff --git a/gallery/how_to/deploy_models/deploy_model_on_adreno.py b/gallery/how_to/deploy_models/deploy_model_on_adreno.py
@@ -120,12 +120,6 @@
 # -----------------
 # As an example we would use classical cat image from ImageNet
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 from PIL import Image
 from tvm.contrib.download import download_testdata
 from matplotlib import pyplot as plt

diff --git a/gallery/how_to/deploy_models/deploy_model_on_android.py b/gallery/how_to/deploy_models/deploy_model_on_android.py
@@ -25,11 +25,6 @@
 This is an example of using Relay to compile a keras model and deploy it on Android device.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 import os
 import numpy as np

diff --git a/gallery/how_to/deploy_models/deploy_model_on_nano.py b/gallery/how_to/deploy_models/deploy_model_on_nano.py
@@ -27,11 +27,7 @@
 
 # sphinx_gallery_start_ignore
 # sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
 # sphinx_gallery_end_ignore
-
 import tvm
 from tvm import te
 import tvm.relay as relay

diff --git a/gallery/how_to/deploy_models/deploy_model_on_rasp.py b/gallery/how_to/deploy_models/deploy_model_on_rasp.py
@@ -26,12 +26,6 @@
 it on Raspberry Pi.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 import tvm
 from tvm import te
 import tvm.relay as relay

diff --git a/gallery/how_to/deploy_models/deploy_object_detection_pytorch.py b/gallery/how_to/deploy_models/deploy_object_detection_pytorch.py
@@ -40,12 +40,6 @@
 be unstable.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 import tvm
 from tvm import relay
 from tvm import relay

diff --git a/gallery/how_to/deploy_models/deploy_prequantized.py b/gallery/how_to/deploy_models/deploy_prequantized.py
@@ -28,11 +28,6 @@
 Once loaded, we can run compiled, quantized models on any hardware TVM supports.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 #################################################################################
 # First, necessary imports

diff --git a/gallery/how_to/deploy_models/deploy_prequantized_tflite.py b/gallery/how_to/deploy_models/deploy_prequantized_tflite.py
@@ -42,11 +42,6 @@
 
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 ###############################################################################
 # Necessary imports

diff --git a/gallery/how_to/deploy_models/deploy_quantized.py b/gallery/how_to/deploy_models/deploy_quantized.py
@@ -27,11 +27,6 @@
 Relay, quantize the Relay model and then perform the inference.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 import tvm
 from tvm import te

diff --git a/gallery/how_to/deploy_models/deploy_sparse.py b/gallery/how_to/deploy_models/deploy_sparse.py
@@ -70,11 +70,6 @@
 sparse speed using fake weights to see the benefit of structured sparsity.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 ###############################################################################
 # Load Required Modules

diff --git a/gallery/how_to/deploy_models/deploy_ssd_gluoncv.py b/gallery/how_to/deploy_models/deploy_ssd_gluoncv.py
@@ -24,11 +24,6 @@
 We will use GluonCV pre-trained SSD model and convert it to Relay IR
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 import tvm
 from tvm import te
 

diff --git a/gallery/how_to/extend_tvm/bring_your_own_datatypes.py b/gallery/how_to/extend_tvm/bring_your_own_datatypes.py
@@ -52,11 +52,6 @@
     ctypes.CDLL('my-datatype-lib.so', ctypes.RTLD_GLOBAL)
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 ######################
 # A Simple TVM Program

diff --git a/gallery/how_to/extend_tvm/low_level_custom_pass.py b/gallery/how_to/extend_tvm/low_level_custom_pass.py
@@ -41,11 +41,6 @@
 
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 import tvm
 from tvm import te
 import numpy as np

diff --git a/gallery/how_to/extend_tvm/use_pass_infra.py b/gallery/how_to/extend_tvm/use_pass_infra.py
@@ -40,11 +40,6 @@
 The same approach can be used for tir as well.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 import numpy as np
 import tvm

diff --git a/gallery/how_to/extend_tvm/use_pass_instrument.py b/gallery/how_to/extend_tvm/use_pass_instrument.py
@@ -34,11 +34,6 @@
 passes. Please also refer to the :ref:`pass-infra`.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 import tvm
 import tvm.relay as relay
 from tvm.relay.testing import resnet

diff --git a/gallery/how_to/optimize_operators/opt_conv_cuda.py b/gallery/how_to/optimize_operators/opt_conv_cuda.py
@@ -30,13 +30,6 @@
 
 """
 
-# sphinx_gallery_start_ignore
-# sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
-
 ################################################################
 # Preparation and Algorithm
 # -------------------------
@@ -47,6 +40,9 @@
 # convolution. The following code defines the convolution algorithm in TVM.
 #
 
+# sphinx_gallery_start_ignore
+# sphinx_gallery_requires_cuda = True
+# sphinx_gallery_end_ignore
 import numpy as np
 import tvm
 from tvm import te

diff --git a/gallery/how_to/optimize_operators/opt_conv_tensorcore.py b/gallery/how_to/optimize_operators/opt_conv_tensorcore.py
@@ -53,11 +53,7 @@
 
 # sphinx_gallery_start_ignore
 # sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
 # sphinx_gallery_end_ignore
-
 import tvm
 from tvm import te
 import numpy as np

diff --git a/gallery/how_to/optimize_operators/opt_gemm.py b/gallery/how_to/optimize_operators/opt_gemm.py
@@ -48,11 +48,6 @@
 Intel i7-4770HQ CPU. The cache line size should be 64 bytes for all the x86 CPUs.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 ################################################################################################
 # Preparation and Baseline

diff --git a/gallery/how_to/tune_with_autoscheduler/tune_conv2d_layer_cuda.py b/gallery/how_to/tune_with_autoscheduler/tune_conv2d_layer_cuda.py
@@ -39,11 +39,7 @@
 
 # sphinx_gallery_start_ignore
 # sphinx_gallery_requires_cuda = True
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
 # sphinx_gallery_end_ignore
-
 import os
 
 import numpy as np

diff --git a/gallery/how_to/tune_with_autoscheduler/tune_network_arm.py b/gallery/how_to/tune_with_autoscheduler/tune_network_arm.py
@@ -46,11 +46,6 @@
 __name__ == "__main__":` block.
 """
 
-# sphinx_gallery_start_ignore
-from tvm import testing
-
-testing.utils.install_request_hook(depth=3)
-# sphinx_gallery_end_ignore
 
 import numpy as np
 import os