Improve keep_intermediate to enable keeping IR after each pass #1791
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
paul0403
reviewed
Jun 6, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1791 +/- ##
=======================================
Coverage 96.60% 96.61%
=======================================
Files 82 82
Lines 9221 9241 +20
Branches 872 877 +5
=======================================
+ Hits 8908 8928 +20
Misses 254 254
Partials 59 59 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
erick-xanadu
reviewed
Jun 6, 2025
paul0403
reviewed
Jun 9, 2025
| @@ -95,6 +95,14 @@ | |||
| performance by eliminating indirect conversion. | |||
| [(#1738)](https://github.com/PennyLaneAI/catalyst/pull/1738) | |||
|
|
|||
| * The `keep_intermediate` argument in the `qjit` decorator now accepts a new value that allows for | |||
| saving intermediate files after each pass. The updated possible options for this argument are: | |||
| * `False` or `0` or `"none"`: No intermediate files are kept. | |||
There was a problem hiding this comment.
Wait, is it the string "none" or the python None?
Comment on lines
+354
to
+356
| if options.keep_intermediate >= KeepIntermediateLevel.PASS: | ||
| extra_args += ["--save-ir-after-each=pass"] | ||
|
|
There was a problem hiding this comment.
I think it makes more sense to put the two if options.keep_intermediate blocks together
| :attr:`~.QJIT.mlir`, :attr:`~.QJIT.mlir_opt`, :attr:`~.QJIT.jaxpr`, | ||
| and :attr:`~.QJIT.qir`, representing different stages in the optimization process. | ||
| keep_intermediate (Union[str, int, bool]): Level controlling intermediate file generation. | ||
| - ``False`` or ``0`` or ``"none"`` (default): No intermediate files are kept. |
There was a problem hiding this comment.
Same here, is this the string or the python None?
Comment on lines
+62
to
+66
| case _: | ||
| raise ValueError( | ||
| f"Invalid value for keep_intermediate: {level}. " | ||
| "Valid values are True, False, 0, 1, 2, 'none', 'pipeline', 'pass'." | ||
| ) |
There was a problem hiding this comment.
Hmm, does the python None come to this error case? Since the above is matching for the string
There was a problem hiding this comment.
Also are booleans parsed here? 🤔
Comment on lines
+132
to
+133
| assert "--save-ir-after-each=pass" not in flags | ||
| assert flags.count("--save-ir-after-each=pass") <= 1 |
Comment on lines
+140
to
+141
| assert "--save-ir-after-each=pass" in flags | ||
| assert flags.count("--save-ir-after-each=pass") == 1 |
paul0403
approved these changes
Jun 9, 2025
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.
Context:
keep_intermediateis a boolean flag that if enabled, keeps the intermediate IR files after each pipeline. However, it is quite common that a developer needs the IR after a specific pass, which is not accessible in the current format viakeep_intermediate.Description of the Change:
Added a third level to the
keep_intermediatethat enables accessing the IR in a more fine grained format i.e. after each pass.Note that this is not a breaking change, meaning that the current behaviour of
keep_intermediateis kept intact.With this PR, the user can provide three different levels of printing:
Falseor0or"none"(default): No intermediate files are kept.Trueor1or"basic": Standard intermediate files are kept (IR after each pipeline).2or"debug": Standard intermediate files are kept, and IR is saved after each pass.Benefits:
easier development and debugging
Possible Drawbacks:
Related GitHub Issues: