Merge pull request #6 from pytorch-labs/refactor_website_markdown

[torch.compile Graph Break Website] Entire refactor of website to markdown files

Author: Sidharth123-cpu

GBID directory/_config.yml

@@ -0,0 +1,23 @@
+# Site settings
+title: Graph-Break Registry
+description: A registry of PyTorch Dynamo graph breaks.
+
+# Base URL for the site
+# This is crucial for correct linking on GitHub Pages
+baseurl: "/docs/compile-graph-break" # Adjust this based on your actual GitHub Pages path
+
+# Build settings
+theme: jekyll-theme-minimal # Or any other Jekyll theme you prefer
+remote_theme: pages-themes/minimal@v0.2.0 # For GitHub Pages remote theme
+plugins:
+  - jekyll-remote-theme
+
+# Exclude build-related files from Jekyll processing
+exclude:
+  - node_modules
+  - package.json
+  - package-lock.json
+  - generate-site.js
+  - README.md
+  - .gitignore
+  - .github

GBID directory/gb/gb0000.md

@@ -0,0 +1,21 @@
+# GB0000
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+All __torch_function__ overrides returned NotImplemented due to TypeError from user code
+
+## Context
+*Values or code snippet captured at the break point*
+fn={fn}, args={args}, kwargs={kwargs}
+
+## Explanation
+*Why this specific graph break happened*
+All __torch_function__ overrides for for function {fn} returned NotImplemented
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Dynamo has detected that tracing the code will result in an error when running in eager. Please double check that your code doesn't contain a similar error when actually running eager/uncompiled.
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0001.md

@@ -0,0 +1,22 @@
+# GB0001
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Argument of `as_subclass` must be a non-dispatcher-style tensor subclass
+
+## Context
+*Values or code snippet captured at the break point*
+{self}.as_subclass({cls})
+
+## Explanation
+*Why this specific graph break happened*
+Currently not supported
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Avoid this call or move it outside `torch.compile` regione
+- It may be possible to write Dynamo tracing rules for this code. Please report an issue to PyTorch if you encounter this graph break often and it is causing performance issues.
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0002.md

@@ -0,0 +1,21 @@
+# GB0002
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Assertion failed on symbolic shapes
+
+## Context
+*Values or code snippet captured at the break point*
+str(sym_expr)
+
+## Explanation
+*Why this specific graph break happened*
+*No explanation provided.*
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Dynamo has detected that tracing the code will result in an error when running in eager. Please double check that your code doesn't contain a similar error when actually running eager/uncompiled.
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0003.md

@@ -0,0 +1,23 @@
+# GB0003
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Attempt to trace generator
+
+## Context
+*Values or code snippet captured at the break point*
+*No context provided.*
+
+## Explanation
+*Why this specific graph break happened*
+Generators cannot be compiled directly with `torch.compile`.
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Call a generator from inside of a non-generator Python function and 
+- compile that function instead.
+- This graph break is fundamental - it is unlikely that Dynamo will ever be able to trace through your code. Consider finding a workaround.
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0004.md

@@ -0,0 +1,22 @@
+# GB0004
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Attempted super().__delattr__() on an object without mutation tracking
+
+## Context
+*Values or code snippet captured at the break point*
+call_method {self} {name}
+
+## Explanation
+*Why this specific graph break happened*
+Dynamo needs to track mutations on an object before `super().__delattr__` can be used on it. But the object ({self.objvar}) doesn't have attribute mutation tracking enabled.
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Ensure the object is tracked by Dynamo's side effect system.
+- This is likely to be a Dynamo bug. Please report an issue to PyTorch.
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0005.md

@@ -0,0 +1,21 @@
+# GB0005
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Attempted to a str() method implemented in C/C++
+
+## Context
+*Values or code snippet captured at the break point*
+*No context provided.*
+
+## Explanation
+*Why this specific graph break happened*
+{type(arg.value)} has a C/C++ based str method. This is not supported.
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Write the str method in Python
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0006.md

@@ -0,0 +1,21 @@
+# GB0006
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Attempted to call a super() attribute that is not a function or method
+
+## Context
+*Values or code snippet captured at the break point*
+call_method {self} {name}
+
+## Explanation
+*Why this specific graph break happened*
+Dynamo does not know how to trace the call `super().{name}()` because `super().{name}` is not a function or method attribute.
+
+## Hints
+*Suggestions for fixing or working around the break*
+- Ensure the attribute accessed via `super()` is a standard method or function.
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0007.md

@@ -0,0 +1,21 @@
+# GB0007
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Attempted to call function marked as skipped
+
+## Context
+*Values or code snippet captured at the break point*
+module: {module_name}, qualname: {qualname}, skip reason: {reason}
+
+## Explanation
+*Why this specific graph break happened*
+explanation
+
+## Hints
+*Suggestions for fixing or working around the break*
+*No hints provided.*
+
+
+
+[Back to Registry](../index.md)

GBID directory/gb/gb0008.md

@@ -0,0 +1,21 @@
+# GB0008
+
+## Graph-Break Type
+*Short name describing what triggered the graph break*
+Attempted to inline function marked as skipped
+
+## Context
+*Values or code snippet captured at the break point*
+qualname: {fn_qualname}, name: {func.get_name()}, filename: `{func.get_filename()}`, skip reason: {result.reason}
+
+## Explanation
+*Why this specific graph break happened*
+Dynamo developers have intentionally marked that the function `{fn_qualname}` should not be traced.
+
+## Hints
+*Suggestions for fixing or working around the break*
+*No hints provided.*
+
+
+
+[Back to Registry](../index.md)