From 8925478b1babf503b1b6836ce6ad9c2a6a42e219 Mon Sep 17 00:00:00 2001 From: Misty-W <82074193+Misty-W@users.noreply.github.com> Date: Wed, 26 Feb 2025 13:26:24 -0800 Subject: [PATCH 1/4] Prepare for 0.4.3 --- CHANGELOG.rst | 46 ++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- 2 files changed, 47 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 754c8bca..46dabd8d 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,52 @@ Changelog ========= +[0.4.3] - 2025-02-26 +-------------------- + +In version 0.4.3, we enhanced UCC infrastructure, benchmarking, and documentation. +Release highlights include the introduction of +[Poetry](https://github.com/python-poetry/install.python-poetry.org) for dependency management, +the automated display of results from benchmarks run on the `main` branch, +and plotting of expectation value benchmark results. +In the case of quantum volume circuits, we changed the expectation value metric from the default +ZZZZZZZZZZZ observable to the heavy output probability. + + +### Added +Mention benchpress explicitly in License section. #241 [@jordandsullivan] +Add target gate set for cirq benchmarking #224 [@bachase] +Add ruff for linting and formating #216 [@bachase] +Added warnings to top level compile function for trying to import non-supported python versions #185 [@jordandsullivan] +Add explicit Sphinx config in .readthedocs.yaml file #180 [@Misty-W] + + +### Fixed +Ensure benchmarking runs don't add gitignored files #247 [@bachase] +Pull latest compatible version of libraries when generating benchmark docker #244 [@bachase] +Fix broken links in docs #240 [@bachase] +Fix spelling mistake #237 [@natestemen] +Fix relative path bug in expval benchmarking script #231 [@natestemen] +Fix typo in readme for supported formats #230 [@bachase] +Fix benchmark script to work with poetry #214 [@bachase] +Combine recent data files w/ incomplete benchmarks #207 [@Misty-W] + + +### Changed +Update Install Poetry link to instructions for installation #257 [@jordandsullivan] +Upgrade dependencies #250 [@bachase] +Change QV error rates back to global variables #248 [@Misty-W] +Update documentation to expand on design goals: #245 [@bachase] +Change expectation value metric to HOP for QV circuits #223 [@Misty-W] +Switch to poetry for dependency management #208 [@bachase] +Test run benchmarks with simple wording change #205 [@Misty-W] +Wording #198 [@jordandsullivan] +Test deploy key push access #197 [@jordandsullivan] +Plot adjustments #183 by jordandsullivan +Minor docs updates #181 by Misty-W +Update README.md #178 by willzeng + + [0.4.2] - 2025-01-17 -------------------- diff --git a/pyproject.toml b/pyproject.toml index 9c540c6f..8881adb7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "ucc" -version = "0.4.2" +version = "0.4.3" description = "Unitary Compiler Collection: A quantum circuit interface and compiler for multiple quantum frameworks" authors = [ {name="Jordan Sullivan", email="jordan@unitary.foundation"}, From 59302346c5b34899183fd9221f63bc9918e5b727 Mon Sep 17 00:00:00 2001 From: Misty-W <82074193+Misty-W@users.noreply.github.com> Date: Wed, 26 Feb 2025 13:52:07 -0800 Subject: [PATCH 2/4] Add most recent PR to changelog; fix format --- CHANGELOG.rst | 81 +++++++++++++++++++++++++++++---------------------- 1 file changed, 46 insertions(+), 35 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 46dabd8d..3ef538d3 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -13,38 +13,46 @@ In the case of quantum volume circuits, we changed the expectation value metric ZZZZZZZZZZZ observable to the heavy output probability. -### Added -Mention benchpress explicitly in License section. #241 [@jordandsullivan] -Add target gate set for cirq benchmarking #224 [@bachase] -Add ruff for linting and formating #216 [@bachase] -Added warnings to top level compile function for trying to import non-supported python versions #185 [@jordandsullivan] -Add explicit Sphinx config in .readthedocs.yaml file #180 [@Misty-W] - - -### Fixed -Ensure benchmarking runs don't add gitignored files #247 [@bachase] -Pull latest compatible version of libraries when generating benchmark docker #244 [@bachase] -Fix broken links in docs #240 [@bachase] -Fix spelling mistake #237 [@natestemen] -Fix relative path bug in expval benchmarking script #231 [@natestemen] -Fix typo in readme for supported formats #230 [@bachase] -Fix benchmark script to work with poetry #214 [@bachase] -Combine recent data files w/ incomplete benchmarks #207 [@Misty-W] - - -### Changed -Update Install Poetry link to instructions for installation #257 [@jordandsullivan] -Upgrade dependencies #250 [@bachase] -Change QV error rates back to global variables #248 [@Misty-W] -Update documentation to expand on design goals: #245 [@bachase] -Change expectation value metric to HOP for QV circuits #223 [@Misty-W] -Switch to poetry for dependency management #208 [@bachase] -Test run benchmarks with simple wording change #205 [@Misty-W] -Wording #198 [@jordandsullivan] -Test deploy key push access #197 [@jordandsullivan] -Plot adjustments #183 by jordandsullivan -Minor docs updates #181 by Misty-W -Update README.md #178 by willzeng +:heading-level: 3 Added + +- Mention benchpress explicitly in License section. #241 [@jordandsullivan] +- Add target gate set for cirq benchmarking #224 [@bachase] +- Add ruff for linting and formating #216 [@bachase] +- Added warnings to top level compile function for trying to import non-supported python versions #185 [@jordandsullivan] +- Add explicit Sphinx config in .readthedocs.yaml file #180 [@Misty-W] + + +:heading-level: 3 Fixed + +- Ensure benchmarking runs don't add gitignored files #247 [@bachase] +- Pull latest compatible version of libraries when generating benchmark docker #244 [@bachase] +- Fix broken links in docs #240 [@bachase] +- Fix spelling mistake #237 [@natestemen] +- Fix relative path bug in expval benchmarking script #231 [@natestemen] +- Fix typo in readme for supported formats #230 [@bachase] +- Fix benchmark script to work with poetry #214 [@bachase] +- Combine recent data files w/ incomplete benchmarks #207 [@Misty-W] + + +:heading-level: 3 Changed + +- Update Install Poetry link to instructions for installation #257 [@jordandsullivan] +- Upgrade dependencies #250 [@bachase] +- Change QV error rates back to global variables #248 [@Misty-W] +- Update documentation to expand on design goals: #245 [@bachase] +- Change expectation value metric to HOP for QV circuits #223 [@Misty-W] +- Switch to poetry for dependency management #208 [@bachase] +- Test run benchmarks with simple wording change #205 [@Misty-W] +- Wording #198 [@jordandsullivan] +- Test deploy key push access #197 [@jordandsullivan] +- Plot adjustments #183 by jordandsullivan +- Minor docs updates #181 by Misty-W +- Update README.md #178 by willzeng + + +:heading-level: 3 Removed + +- Remove custom transpilation passes #256 [@bachase] [0.4.2] - 2025-01-17 @@ -55,7 +63,8 @@ Version 0.4.2 marks the first formal release to [PyPI](https://pypi.org/project/ This release contains the default UCC compilation workflow, including circuit translation and optimization passes, pass management, and the user interface. It also encompasses benchmarking scripts and utilities, tests, documentation, and basic infrastructure. -### Added +:heading-level: 3 Added + - PyPI release #165 [@Misty-W] - Add RTD for online documentation #164 [@natestemen] - Create contribution guide #157 [@natestemen] @@ -100,7 +109,8 @@ It also encompasses benchmarking scripts and utilities, tests, documentation, an - Choose a license #1 [@jordandsullivan] -### Fixed +:heading-level: 3 Fixed + - Install error due to openqasm versioning #154 [@Misty-W] - fix small_test.sh CLI command to deal with spaces in paths #152 [@willzeng] - Mismatched headers in datafiles #148 [@jordandsullivan] @@ -114,6 +124,7 @@ It also encompasses benchmarking scripts and utilities, tests, documentation, an - Hidden rust dependency on install #74 [@Misty-W] -### Removed +:heading-level: 3 Removed + - Remove innaccurate data for multi-q gates #86 [@jordandsullivan] - Remove QuantumTranslator references #23 [@jordandsullivan] From 90bce903791c1e1bcde12a25852ad8a83a131e76 Mon Sep 17 00:00:00 2001 From: Misty-W <82074193+Misty-W@users.noreply.github.com> Date: Wed, 26 Feb 2025 14:14:46 -0800 Subject: [PATCH 3/4] Update headings in CHANGELOG.rst --- CHANGELOG.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3ef538d3..84a82fb3 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -13,7 +13,8 @@ In the case of quantum volume circuits, we changed the expectation value metric ZZZZZZZZZZZ observable to the heavy output probability. -:heading-level: 3 Added +Added +^^^^^^^^^^^^^^^^^^^^^ - Mention benchpress explicitly in License section. #241 [@jordandsullivan] - Add target gate set for cirq benchmarking #224 [@bachase] @@ -22,7 +23,8 @@ ZZZZZZZZZZZ observable to the heavy output probability. - Add explicit Sphinx config in .readthedocs.yaml file #180 [@Misty-W] -:heading-level: 3 Fixed +Fixed +^^^^^^^^^^^^^^^^^^^^^ - Ensure benchmarking runs don't add gitignored files #247 [@bachase] - Pull latest compatible version of libraries when generating benchmark docker #244 [@bachase] @@ -34,7 +36,8 @@ ZZZZZZZZZZZ observable to the heavy output probability. - Combine recent data files w/ incomplete benchmarks #207 [@Misty-W] -:heading-level: 3 Changed +Changed +^^^^^^^^^^^^^^^^^^^^^ - Update Install Poetry link to instructions for installation #257 [@jordandsullivan] - Upgrade dependencies #250 [@bachase] @@ -50,7 +53,8 @@ ZZZZZZZZZZZ observable to the heavy output probability. - Update README.md #178 by willzeng -:heading-level: 3 Removed +Removed +^^^^^^^^^^^^^^^^^^^^^ - Remove custom transpilation passes #256 [@bachase] @@ -63,7 +67,8 @@ Version 0.4.2 marks the first formal release to [PyPI](https://pypi.org/project/ This release contains the default UCC compilation workflow, including circuit translation and optimization passes, pass management, and the user interface. It also encompasses benchmarking scripts and utilities, tests, documentation, and basic infrastructure. -:heading-level: 3 Added +Added +^^^^^^^^^^^^^^^^^^^^^ - PyPI release #165 [@Misty-W] - Add RTD for online documentation #164 [@natestemen] @@ -109,7 +114,8 @@ It also encompasses benchmarking scripts and utilities, tests, documentation, an - Choose a license #1 [@jordandsullivan] -:heading-level: 3 Fixed +Fixed +^^^^^^^^^^^^^^^^^^^^^ - Install error due to openqasm versioning #154 [@Misty-W] - fix small_test.sh CLI command to deal with spaces in paths #152 [@willzeng] @@ -124,7 +130,8 @@ It also encompasses benchmarking scripts and utilities, tests, documentation, an - Hidden rust dependency on install #74 [@Misty-W] -:heading-level: 3 Removed +Removed +^^^^^^^^^^^^^^^^^^^^^ - Remove innaccurate data for multi-q gates #86 [@jordandsullivan] - Remove QuantumTranslator references #23 [@jordandsullivan] From d1204a4c04a3909154afc5f78e262b206dab4862 Mon Sep 17 00:00:00 2001 From: Misty-W <82074193+Misty-W@users.noreply.github.com> Date: Thu, 27 Feb 2025 11:04:34 -0800 Subject: [PATCH 4/4] Include most recent PRs --- CHANGELOG.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 84a82fb3..76681e98 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -39,6 +39,8 @@ Fixed Changed ^^^^^^^^^^^^^^^^^^^^^ +- Run pytest before ruff linter checks #267 [@jordandsullivan] +- Clarify poetry usage #265 [@bachase] - Update Install Poetry link to instructions for installation #257 [@jordandsullivan] - Upgrade dependencies #250 [@bachase] - Change QV error rates back to global variables #248 [@Misty-W]