Skip to content
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

Exclude OQD packages, modules and data from wheels #1403

Merged
merged 5 commits into from
Jan 3, 2025

Conversation

joeycarter
Copy link
Contributor

Context: A number of OQD packages, modules and data files had been added recently (e.g. #1348 and #1355). However, as support for OQD devices is still under development, these files should not be included in the wheels.

Description of the Change: Excludes all OQD packages, modules and data files (such as toml config files) from the wheels. Furthermore, the OQD device entry in the Supported devices documentation has also been removed.

@joeycarter
Copy link
Contributor Author

Confirming that there are no OQD files in the wheels:

$ make wheel
$ unzip -l dist/*.whl | grep -i "oqd"
# No output

@joeycarter
Copy link
Contributor Author

joeycarter commented Jan 2, 2025

Most of these changes can be reverted once OQD device support is complete and ready for release. However, note that the addition of "catalyst.third_party.oqd.*" in the list of excluded packages in setup.py should remain. This line should have been there from the get-go, since building the OQD package installs a number of third-party modules under frontend/catalyst/third_party/oqd/src/build/ (e.g. catch2), which should not be included in the wheels.

@joeycarter joeycarter added author:build-wheels Run the wheel building workflows on this Pull Request urgent Mark a pull request as high priority labels Jan 2, 2025
@joeycarter joeycarter marked this pull request as ready for review January 2, 2025 19:27
@joeycarter joeycarter requested a review from dime10 January 2, 2025 19:30
Copy link
Contributor

@dime10 dime10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Joey! 🚀

We might even consider dropping the changelog entries altogether if the entire source is excluded from distribution, but that can be decided during the release prep :)

@joeycarter
Copy link
Contributor Author

Thanks Joey! 🚀

We might even consider dropping the changelog entries altogether if the entire source is excluded from distribution, but that can be decided during the release prep :)

Thanks @dime10! I'm fine to leave the changelog entry in for now; I think it's mostly correct to say that an addition or modification to the source code that is not released is an "Internal change". Maybe we could also have an "Unreleased" section in the changelog for PRs like this. TBD during the release planning!

@joeycarter joeycarter merged commit b741618 into main Jan 3, 2025
58 checks passed
@joeycarter joeycarter deleted the joeycarter/remove-oqd-from-wheels branch January 3, 2025 13:40
@joeycarter joeycarter removed the urgent Mark a pull request as high priority label Jan 3, 2025
mehrdad2m pushed a commit that referenced this pull request Jan 6, 2025
**Context:** A number of OQD packages, modules and data files had been
added recently (e.g. #1348 and #1355). However, as support for OQD
devices is still under development, these files should not be included
in the wheels.

**Description of the Change:** Excludes _all_ OQD packages, modules and
data files (such as toml config files) from the wheels. Furthermore, the
OQD device entry in the [Supported devices
documentation](https://docs.pennylane.ai/projects/catalyst/en/stable/dev/devices.html)
has also been removed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author:build-wheels Run the wheel building workflows on this Pull Request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants