Updates to the rewriter tutorial #2397
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>
Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>
Signed-off-by: Ganesan Ramalingam <grama@microsoft.com>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the rewriter tutorial documentation by improving explanations and demonstrating an alternative class-based approach to defining rewrite rules.
- Introduces a class-based rewrite rule example in the tutorial.
- Enhances documentation on conditional rewrite rules and commutativity handling.
- Updates the index order and adjusts descriptive text in several markdown files.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorial/rewriter/simple_example.md | Refactored the tutorial to demonstrate an alternative class-based definition for rewrite rules. |
| docs/tutorial/rewriter/rewrite_patterns.md | Updated text to indicate that rewrite rules are conditional. |
| docs/tutorial/rewriter/examples/erfgelu.py | Added a new class-based rewrite rule implementation example. |
| docs/tutorial/rewriter/conditional_rewrite.md | Revised explanation for condition checking with additional IR details. |
| docs/tutorial/rewriter/commute.md | Expanded discussion on commutativity handling and introduced a warning regarding rule explosion. |
| docs/tutorial/index.md | Adjusted the ordering for the toctree entries. |
Comments suppressed due to low confidence (1)
docs/tutorial/rewriter/simple_example.md:65
- Consider revising the sentence to include a verb, for example: 'This parameter is either a
Sequence[PatternRewriteRule]or aRewriteRuleSet.'
2. `pattern_rewrite_rules` : This parameter either a `Sequence[PatternRewriteRule]` or a `RewriteRuleSet`.
justinchuby
reviewed
Jun 18, 2025
justinchuby
reviewed
Jun 18, 2025
| @@ -31,7 +31,11 @@ The target pattern in this case has 5 inputs `input_a`, `input_b`, `shape_a`, `s | |||
| Similarly for writing the condition checking function, we require only `input_a`, `input_b` and `shape_c`. Use `**_` to represent all the unused parameters in the condition matching function signature. | |||
| ::: | |||
|
|
|||
| In order to validate whether matmul broadcast is sufficient, we write a condition checking function as follows: | |||
| In order to validate whether matmul broadcast is sufficient, we write a condition checking function as below. | |||
| Note that the relevant inputs passed to the check function are all instances of `ir.Value`. These represent | |||
There was a problem hiding this comment.
Suggested change
| Note that the relevant inputs passed to the check function are all instances of `ir.Value`. These represent | |
| Note that the relevant inputs passed to the check function are all instances of :class:`onnx_ir.Value`. These represent |
There was a problem hiding this comment.
Will this work, given that IR has moved to a different repo? Not sure if the old documentation still exists, but still ...
There was a problem hiding this comment.
I did add a reference to the overall documentation in the lines below.
justinchuby
added
the
topic: documentation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates to the rewriter tutorial