[export] Add non-strict and derived dims tutorials

Author: angelayi

intermediate_source/torch_export_tutorial.py

@@ -114,11 +114,12 @@ def forward(self, x, y):
 # ------------
 #
 # Although ``torch.export`` shares components with ``torch.compile``,
-# the key limitation of ``torch.export``, especially when compared to ``torch.compile``, is that it does not
-# support graph breaks. This is because handling graph breaks involves interpreting
-# the unsupported operation with default Python evaluation, which is incompatible
-# with the export use case. Therefore, in order to make your model code compatible
-# with ``torch.export``, you will need to modify your code to remove graph breaks.
+# the key limitation of ``torch.export``, especially when compared to
+# ``torch.compile``, is that it does not support graph breaks. This is because
+# handling graph breaks involves interpreting the unsupported operation with
+# default Python evaluation, which is incompatible with the export use case.
+# Therefore, in order to make your model code compatible with ``torch.export``,
+# you will need to modify your code to remove graph breaks.
 #
 # A graph break is necessary in cases such as:
 #
@@ -180,8 +181,68 @@ def forward(self, x):
     tb.print_exc()
 
 ######################################################################
-# The sections below demonstrate some ways you can modify your code
-# in order to remove graph breaks.
+# Non-Strict Export
+# -----------------
+#
+# To trace the program, ``torch.export`` uses TorchDynamo, a byte code analysis
+# engine, to symbolically analyze the Python code and build a graph based on the
+# results. This analysis allows ``torch.export`` to provide stronger guarantees
+# about safety, but not all Python code is supported, causing these graph
+# breaks.
+#
+# To address this issue, in PyTorch 2.3, we introduced a new mode of
+# exporting called non-strict mode, where we trace through the program using the
+# Python interpreter executing it exactly as it would in eager mode, allowing us
+# to skip over unsupported Python features. This is done through adding a
+# ``strict=False`` flag.
+#
+# Looking at some of the previous examples which resulted in graph breaks:
+#
+# - Accessing tensor data with ``.data`` now works correctly
+
+class Bad2(torch.nn.Module):
+    def forward(self, x):
+        x.data[0, 0] = 3
+        return x
+
+bad2_nonstrict = export(Bad2(), (torch.randn(3, 3),), strict=False)
+print(bad2_nonstrict.module()(torch.ones(3, 3)))
+
+######################################################################
+# - Calling unsupported functions (such as many built-in functions) traces
+# through, but in this case, ``id(x)`` gets specialized as a constant integer in
+# the graph. This is because ``id(x)`` is not a tensor operation, so the
+# operation is not recorded in the graph.
+
+class Bad3(torch.nn.Module):
+    def forward(self, x):
+        x = x + 1
+        return x + id(x)
+
+bad3_nonstrict = export(Bad3(), (torch.randn(3, 3),), strict=False)
+print(bad3_nonstrict)
+print(bad3_nonstrict.module()(torch.ones(3, 3)))
+
+######################################################################
+# - Unsupported Python language features (such as throwing exceptions, match
+# statements) now also get traced through.
+
+class Bad4(torch.nn.Module):
+    def forward(self, x):
+        try:
+            x = x + 1
+            raise RuntimeError("bad")
+        except:
+            x = x + 2
+        return x
+
+bad4_nonstrict = export(Bad4(), (torch.randn(3, 3),), strict=False)
+print(bad4_nonstrict.module()(torch.ones(3, 3)))
+
+
+######################################################################
+# However, there are still some features that require rewrites to the original
+# module:
 
 ######################################################################
 # Control Flow Ops
@@ -365,6 +426,29 @@ def forward(self, x, y):
 except Exception:
     tb.print_exc()
 
+######################################################################
+# We can also describe one dimension in terms of other.
+
+class DerivedDimExample(torch.nn.Module):
+    def forward(self, x, y):
+        return x + y[1:]
+
+foo = DerivedDimExample()
+
+x, y = torch.randn(5), torch.randn(6)
+dimx = torch.export.Dim("dimx", min=3, max=6)
+dimy = dimx + 1
+derived_dynamic_shapes = ({0: dimx}, {0: dimy})
+
+derived_dim_example = export(foo, (x, y), dynamic_shapes=derived_dynamic_shapes)
+
+print(derived_dim_example.module()(torch.randn(4), torch.randn(5)))
+
+try:
+    derived_dim_example.module()(torch.randn(4), torch.randn(6))
+except Exception:
+    tb.print_exc()
+
 ######################################################################
 # We can actually use ``torch.export`` to guide us as to which ``dynamic_shapes`` constraints
 # are necessary. We can do this by relaxing all constraints (recall that if we