fix some formatting

Author: williamwen42

intermediate_source/torch_compile_full_example.py

@@ -14,7 +14,7 @@
 #
 # This tutorial covers an end-to-end example of training and evaluating a
 # real model with ``torch.compile``. For a gentle introduction to ``torch.compile``,
-# please check out `the introduction to ``torch.compile`` tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html>`__.
+# please check out `the introduction to torch.compile tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html>`__.
 #
 # **Required pip Dependencies**
 #
@@ -33,7 +33,7 @@
 #     .. grid-item-card:: :octicon:`list-unordered;1em;` Prerequisites
 #        :class-card: card-prerequisites
 #
-#        * `Introduction to ``torch.compile`` <https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html>`__
+#        * `Introduction to torch.compile <https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html>`__
 
 # NOTE: a modern NVIDIA GPU (H100, A100, or V100) is recommended for this tutorial in
 # order to reproduce the speedup numbers shown below and documented elsewhere.
@@ -233,8 +233,8 @@ def train(mod, data):
 # are slower than eager mode due to compilation overhead, but subsequent iterations are expected to
 # have speedups.
 #
-# For a gentle introduction to ``torch.compile``, please check out `the introduction to ``torch.compile`` tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html>`__.
+# For a gentle introduction to ``torch.compile``, please check out `the introduction to torch.compile tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html>`__.
 #
-# To troubleshoot issues and to gain a deeper understanding of how to apply ``torch.compile`` to your code, check out `the ``torch.compile`` programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
+# To troubleshoot issues and to gain a deeper understanding of how to apply ``torch.compile`` to your code, check out `the torch.compile programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
 #
 # We hope that you will give ``torch.compile`` a try!

intermediate_source/torch_compile_tutorial.py

@@ -6,17 +6,6 @@
 **Author:** William Wen
 """
 
-# sphinx_gallery_start_ignore
-# to clear torch logs format
-import torch
-import os
-os.environ["TORCH_LOGS_FORMAT"] = ""
-torch._logging._internal.DEFAULT_FORMATTER = (
-    torch._logging._internal._default_formatter()
-)
-torch._logging._internal._init_logs()
-# sphinx_gallery_end_ignore
-
 ######################################################################
 # ``torch.compile`` is the new way to speed up your PyTorch code!
 # ``torch.compile`` makes PyTorch code run faster by
@@ -36,15 +25,15 @@
 # our previous PyTorch compiler solution,
 # `TorchScript <https://pytorch.org/docs/stable/jit.html>`__.
 #
-# For an end-to-end example on a real model, check out our `end-to-end ``torch.compile`` tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
+# For an end-to-end example on a real model, check out our `end-to-end torch.compile tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
 #
-# To troubleshoot issues and to gain a deeper understanding of how to apply ``torch.compile`` to your code, check out `the ``torch.compile`` programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
+# To troubleshoot issues and to gain a deeper understanding of how to apply ``torch.compile`` to your code, check out `the torch.compile programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
 #
 # **Contents**
 #
 # .. contents::
 #     :local:
-
+#
 # **Required pip dependencies for this tutorial**
 #
 # - ``torch >= 2.0``
@@ -65,6 +54,16 @@
 
 import torch
 
+# sphinx_gallery_start_ignore
+# to clear torch logs format
+import os
+os.environ["TORCH_LOGS_FORMAT"] = ""
+torch._logging._internal.DEFAULT_FORMATTER = (
+    torch._logging._internal._default_formatter()
+)
+torch._logging._internal._init_logs()
+# sphinx_gallery_end_ignore
+
 torch._logging.set_logs(graph_code=True)
 
 ######################################################################
@@ -141,7 +140,7 @@ def forward(self, x):
 # -----------------------
 #
 # Now let's demonstrate how ``torch.compile`` speeds up a simple PyTorch example.
-# For a demonstration on a more complex model, see our `end-to-end ``torch.compile`` tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
+# For a demonstration on a more complex model, see our `end-to-end torch.compile tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
 
 
 def foo3(x):
@@ -215,7 +214,7 @@ def timed(fn):
 # and the amount of data is large, then the bottleneck would be
 # GPU compute and the observed speedup may be less significant.
 #
-# To see speedups on a real model, check out our `end-to-end ``torch.compile`` tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
+# To see speedups on a real model, check out our `end-to-end torch.compile tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
 
 ######################################################################
 # Benefits over TorchScript
@@ -392,10 +391,10 @@ def false_branch(y):
 # In order to serialize graphs or to run graphs on different (i.e. Python-less)
 # environments, consider using ``torch.export`` instead (from PyTorch 2.1+).
 # One important restriction is that ``torch.export`` does not support graph breaks. Please check
-# `this tutorial <https://pytorch.org/tutorials/intermediate/torch_export_tutorial.html>`__
+# `the torch.export tutorial <https://pytorch.org/tutorials/intermediate/torch_export_tutorial.html>`__
 # for more details on ``torch.export``.
 #
-# Check out our `section on graph breaks in the ``torch.compile`` programming model <https://docs.pytorch.org/docs/main/compile/programming_model.graph_breaks_index.html>`__
+# Check out our `section on graph breaks in the torch.compile programming model <https://docs.pytorch.org/docs/main/compile/programming_model.graph_breaks_index.html>`__
 # for tips on how to work around graph breaks.
 
 ######################################################################
@@ -406,7 +405,7 @@ def false_branch(y):
 # Are you looking for tips on how to best use ``torch.compile``?
 # Or maybe you simply want to learn more about the inner workings of ``torch.compile``?
 #
-# Check out `the ``torch.compile`` programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
+# Check out `the torch.compile programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
 
 ######################################################################
 # Conclusion
@@ -416,8 +415,8 @@ def false_branch(y):
 # basic usage, demonstrating speedups over eager mode, comparing to TorchScript,
 # and briefly describing graph breaks.
 #
-# For an end-to-end example on a real model, check out our `end-to-end ``torch.compile`` tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
+# For an end-to-end example on a real model, check out our `end-to-end torch.compile tutorial <https://pytorch.org/tutorials/intermediate/torch_compile_full_example.html>`__.
 #
-# To troubleshoot issues and to gain a deeper understanding of how to apply ``torch.compile`` to your code, check out `the ``torch.compile`` programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
+# To troubleshoot issues and to gain a deeper understanding of how to apply ``torch.compile`` to your code, check out `the torch.compile programming model <https://docs.pytorch.org/docs/main/compile/programming_model.html>`__.
 #
 # We hope that you will give ``torch.compile`` a try!