Expand logging configuration support in PennyLane, and also target Catalyst #5528
Conversation
This file contains 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
3 tasks
|
Hello. You may have forgotten to update the changelog!
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #5528 +/- ##
==========================================
- Coverage 99.67% 99.53% -0.15%
==========================================
Files 416 418 +2
Lines 38686 38873 +187
==========================================
+ Hits 38562 38691 +129
- Misses 124 182 +58 ☔ View full report in Codecov by Sentry. |
5 tasks
mlxd
changed the title
|
[sc-61591] |
mlxd
changed the title
### Before submitting
Please complete the following checklist when submitting a PR:
- [ ] All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to
the
test directory!
- [ ] All new functions and code must be clearly commented and
documented.
If you do make documentation changes, make sure that the docs build and
render correctly by running `make docs`.
- [ ] Ensure that the test suite passes, by running `make test`.
- [ ] Add a new entry to the `doc/releases/changelog-dev.md` file,
summarizing the
change, and including a link back to the PR.
- [ ] The PennyLane source code conforms to
[PEP8 standards](https://www.python.org/dev/peps/pep-0008/).
We check all of our code against [Pylint](https://www.pylint.org/).
To lint modified files, simply `pip install pylint`, and then
run `pylint pennylane/path/to/file.py`.
When all the above are checked, delete everything above the dashed
line and fill in the pull request template.
------------------------------------------------------------------------------------------------------------
**Context:** This PR expands the logging functionality in PennyLane for
both internal and inter-library (e.g. Lightning, Catalyst) use.
**Description of the Change:** Add support for decorator-defined logging
functions, and updates the internal usage of logging with this.
**Benefits:** Allows more ease-of-use by developers to include logging
with new functionality to the library.
**Possible Drawbacks:** Does not replace custom-defined log-level
messages and trace-level expansion of functions.
**Related GitHub Issues:**
#5528
mlxd
changed the title
…I/pennylane into update/logging_rules_catalyst
mudit2812
reviewed
May 28, 2024
mudit2812
reviewed
May 28, 2024
Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai>
Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai>
|
FYI, the CodeCov complaints are due to the newly added untestable source. We ignore these as pytest-runs are negatively impacted in CI runtime if these are hit. |
trbromley
reviewed
May 29, 2024
Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com>
Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com>
trbromley
approved these changes
May 30, 2024
mlxd
added a commit
to PennyLaneAI/catalyst
that referenced
this pull request
Jun 5, 2024
### Before submitting Please complete the following checklist when submitting a PR: - [x] All new functions and code must be clearly commented and documented. - [x] Ensure that code is properly formatted by running `make format`. The latest version of black and `clang-format-14` are used in CI/CD to check formatting. - [ ] All new features must include a unit test. Integration and frontend tests should be added to [`frontend/test`](../frontend/test/), Quantum dialect and MLIR tests should be added to [`mlir/test`](../mlir/test/), and Runtime tests should be added to [`runtime/tests`](../runtime/tests/). When all the above are checked, delete everything above the dashed line and fill in the pull request template. ------------------------------------------------------------------------------------------------------------ **Context:** PennyLane's [logging support](https://docs.pennylane.ai/en/stable/introduction/logging.html) allows developers to explore the execution pipeline end-to-end, while tying into the Python-native logging framework. This has the advantage of being enterprise ready, consumable by a variety of log sinks, and unifies/removes the need for adding `print` statements throughout a code-base, with all control to be handled by the Python [language standard libraries](https://docs.python.org/3/library/logging.html). This PR aims to unify Catalyst to follow the same design as PennyLane to support logging with the same unified configuration, allowing ease of examining of function entry points at the `DEBUG` level, and a custom `TRACE` method for expanding functions passed as arguments. **Description of the Change:** Adds preliminary support to a variety of Catalyst frontend public API entry-points. Any workload using `qml.logging.enable_logging()` allows the function entry data to be streamed to the pre-configured log-handlers from PennyLane. **Benefits:** More easily allows time-order and standardised data formatting for consumption with complex application execution, debugging, and end-to-end validation of call-points. **Possible Drawbacks:** **Related GitHub Issues:** PennyLaneAI/pennylane#5528 --------- Co-authored-by: David Ittah <dime10@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.
Before submitting
Please complete the following checklist when submitting a PR:
All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to the
test directory!
All new functions and code must be clearly commented and documented.
If you do make documentation changes, make sure that the docs build and
render correctly by running
make docs.Ensure that the test suite passes, by running
make test.Add a new entry to the
doc/releases/changelog-dev.mdfile, summarizing thechange, and including a link back to the PR.
The PennyLane source code conforms to
PEP8 standards.
We check all of our code against Pylint.
To lint modified files, simply
pip install pylint, and thenrun
pylint pennylane/path/to/file.py.When all the above are checked, delete everything above the dashed
line and fill in the pull request template.
Context: To better unify PennyLane's logging support, updates to control PennyLane's logging behaviour enabling use with Catalyst allow a unified way to examine execution pipelines throughout the Pythonic layer. This PR expands the configuration of logging, allowing direct editing by a user, as well as adds new module-level log-levels for Catalyst, and expands jax to also enable logging with jaxlib. The above will be useful to define interactions across components in the ecosystem, and aid in building a model of explicit interactions across the packages.
Description of the Change: As above.
Benefits: Expands the logging framework to be more configurable, and extends upcoming support for Catalyst.
Possible Drawbacks:
Related GitHub Issues: