-
Notifications
You must be signed in to change notification settings - Fork 715
Create xDSL universe for the unified compiler #8372
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
973a32d
Create PL xDSL universe
mudit2812 0dbfc7e
Rename functions
mudit2812 cbe0ae9
Add docstrings
mudit2812 c975b91
Add changelog entry
mudit2812 dee6c03
Update changelog
mudit2812 0ede94f
Merge branch 'master' into xdsl-universe
mudit2812 53d5581
Remove universe related code from init files
mudit2812 6b309c3
Add separate file for universe
mudit2812 cc5f6d3
Add dynamic loading capability
mudit2812 59fcc14
Remove Universe import in init file
mudit2812 c0bbcbf
Add tests for universe
mudit2812 b36a753
Fix tests
mudit2812 6216788
Remove compiler_transform logic; add tests
mudit2812 1d12f42
Merge branch 'master' into xdsl-universe
mudit2812 2431b2e
Add try except
mudit2812 24fb2f2
Add pragma: no cover for branch when xDSL is not installed
mudit2812 c2ed692
Reorder imports
mudit2812 5416bc8
Add pylint warning suppression
mudit2812 3092a6d
Add dev comment for context
mudit2812 60e6e3a
Merge branch 'master' into xdsl-universe
mudit2812 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Copyright 2025 Xanadu Quantum Technologies Inc. | ||
|
|
||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
|
|
||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| """xDSL universe for containing all dialects and passes.""" | ||
|
|
||
| xdsl_available = True | ||
|
|
||
| try: | ||
| from xdsl.passes import ModulePass | ||
| from xdsl.universe import Universe | ||
| except (ImportError, ModuleNotFoundError): | ||
| xdsl_available = False # pragma: no cover | ||
|
|
||
| # We must check that xDSL is installed because we're adding an entry point to | ||
| # PennyLane that references this file, and we must ensure that PennyLane can | ||
| # be installed in environments where xDSL is not installed. | ||
| XDSL_UNIVERSE = None | ||
|
|
||
| if xdsl_available: | ||
| # pylint: disable=import-outside-toplevel | ||
| from . import dialects, transforms | ||
|
|
||
| shared_dialects = ("stablehlo", "transform") | ||
|
|
||
| # Create a map from dialect names to dialect classes. Dialects that are already | ||
| # provided by xDSL cannot be loaded into the multiverse, so we don't add them to | ||
| # our universe. | ||
| names_to_dialects = { | ||
| d.name: d | ||
| for name in dialects.__all__ | ||
| if (d := getattr(dialects, name)).name not in shared_dialects | ||
| } | ||
|
|
||
| # Create a map from pass names to their respective ModulePass. The transforms module | ||
| # contains PassDispatcher instances as well as ModulePasses. We only want to collect | ||
| # the ModulePasses. We cannot use issubclass with instances, which is why we first | ||
| # check if isinstance(transform, type). | ||
| names_to_passes = { | ||
| t.name: t | ||
| for name in transforms.__all__ | ||
| if isinstance((t := getattr(transforms, name)), type) and issubclass(t, ModulePass) | ||
| } | ||
|
|
||
| # The Universe is used to expose custom dialects and transforms to xDSL. It is | ||
| # specified as an entry point in PennyLane's pyproject.toml file, which makes | ||
| # it available to look up by xDSL for tools such as xdsl-opt, xdsl-gui, etc. | ||
| XDSL_UNIVERSE = Universe(all_dialects=names_to_dialects, all_passes=names_to_passes) | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Copyright 2025 Xanadu Quantum Technologies Inc. | ||
|
|
||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
|
|
||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| """Unit tests for the xDSL universe.""" | ||
|
|
||
| import pytest | ||
|
|
||
| pytestmark = pytest.mark.external | ||
| pytest.importorskip("xdsl") | ||
|
|
||
| # pylint: disable=wrong-import-position | ||
| from xdsl.passes import ModulePass | ||
| from xdsl.universe import Universe as xUniverse | ||
|
|
||
| from pennylane.compiler.python_compiler import dialects, transforms | ||
| from pennylane.compiler.python_compiler.universe import XDSL_UNIVERSE, shared_dialects | ||
|
|
||
| all_dialects = tuple(getattr(dialects, name) for name in dialects.__all__) | ||
| all_transforms = tuple( | ||
| transform | ||
| for name in transforms.__all__ | ||
| if isinstance((transform := getattr(transforms, name)), type) | ||
| and issubclass(transform, ModulePass) | ||
| ) | ||
|
|
||
|
|
||
| def test_correct_universe(): | ||
| """Test that all the available dialects and transforms are available in the universe.""" | ||
| for d in all_dialects: | ||
| if d.name not in shared_dialects: | ||
| assert d.name in XDSL_UNIVERSE.all_dialects | ||
| assert XDSL_UNIVERSE.all_dialects[d.name] == d | ||
|
|
||
| for t in all_transforms: | ||
| assert t.name in XDSL_UNIVERSE.all_passes | ||
| assert XDSL_UNIVERSE.all_passes[t.name] == t | ||
|
|
||
|
|
||
| def test_correct_multiverse(): | ||
| """Test that all the available dialects and transforms are available in the multiverse.""" | ||
| multiverse = xUniverse.get_multiverse() | ||
|
|
||
| for d in all_dialects: | ||
| assert d.name in multiverse.all_dialects | ||
| if d.name not in shared_dialects: | ||
| assert multiverse.all_dialects[d.name] == d | ||
|
|
||
| for t in all_transforms: | ||
| assert t.name in multiverse.all_passes | ||
| assert multiverse.all_passes[t.name] == t |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we just keep this
ModuleNotFoundError?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ModuleNotFoundErroris for when a package is not installed, butImportErroris for when a package is installed from you're trying to import something from it that doesn't exist. This is a way to future proof the file, so that if xDSL gets reorganized, we don't seeImportErrors. I'd rather just leave it as is.