refactor!: More flexible pytket encoding #849
Open
+2,504
−1,056
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
|
This PR contains breaking changes to the public Rust API. cargo-semver-checks summary |
aborgna-q
changed the title
aborgna-q
force-pushed
the
ab/extract-pytket-extended
branch
from
a260ac4 to
f4ac585
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #849 +/- ##
==========================================
- Coverage 82.54% 80.70% -1.84%
==========================================
Files 72 81 +9
Lines 8827 9698 +871
Branches 8555 9426 +871
==========================================
+ Hits 7286 7827 +541
- Misses 1098 1393 +295
- Partials 443 478 +35
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
aborgna-q
changed the title
|
The blackbox encoding path is missing some test coverage. |
cqc-alec
requested changes
May 22, 2025
| &self, | ||
| typ: &hugr::types::CustomType, | ||
| ) -> Result<Option<RegisterCount>, Tk1ConvertError<<H>::Node>> { | ||
| match typ.name().as_str() { |
There was a problem hiding this comment.
Should we be converting bools to bits as well?
tket2/src/serialize/pytket/tests.rs
Outdated
| .iter() | ||
| .map(|c| serde_json::to_string(c).unwrap()) | ||
| .collect(); | ||
| for b in &b.commands { |
There was a problem hiding this comment.
Shouldn't we be iterating over a.commands here?
There was a problem hiding this comment.
Good catch -.-'
We actually cannot compare commands directly, since the arguments names may change depending on the encoding toposort.
I added a partial comparison instead.
| /// | ||
| /// ## Arguments | ||
| /// | ||
| /// - `node`: The HUGR for which to emit the command. Qubits and bits are |
There was a problem hiding this comment.
Suggested change
| /// - `node`: The HUGR for which to emit the command. Qubits and bits are | |
| /// - `node`: The HUGR node for which to emit the command. Qubits and bits are |
?
| } | ||
| if out_params.len() != total_out_count.params { | ||
| return Err(Tk1ConvertError::custom(format!( | ||
| "Not enough parameters in the input values for a {}. Expected {} but got {}.", |
| /// | ||
| /// - `node`: The node to register the outputs for. | ||
| /// - `circ`: The circuit containing the node. | ||
| /// - `qubit_values`: An iterator of existing qubit ids to re-use for the output. |
There was a problem hiding this comment.
Suggested change
| /// - `qubit_values`: An iterator of existing qubit ids to re-use for the output. | |
| /// - `qubits`: An iterator of existing qubit ids to re-use for the output. |
| // Check that we got the expected number of outputs. | ||
| if out_params.len() != total_out_count.params { | ||
| return Err(Tk1ConvertError::custom(format!( | ||
| "Not enough parameters in the input values for a {}. Expected {} but got {}.", |
| }; | ||
| // Update the values in the node's outputs. | ||
| // | ||
| // We preserve the order of linear values in thpe input |
There was a problem hiding this comment.
Suggested change
| // We preserve the order of linear values in thpe input | |
| // We preserve the order of linear values in the input |
Co-authored-by: Alec Edgington <[email protected]>
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.
This PR rewrites the pytket encoding framework for hugr programs, and serves as a base for PRs to come.
Main changes from the existing implementation:
Extensions can define their own type, operation, and constant translations and register them at runtime.
This is done by registering
impl PytketEmitterobjects, that lets us emit arbitrary pytket commands for a hugr operation.See tket2/src/serialize/pytket/extension/ for how it's done.
Hugr)Circuits that could already be encoded produce the same pytket circuit (up to register reorderings) after this refactor.
Previously unsupported circuits will now be encoded using black box barriers, but we do not include decoding support here.
Not in this PR:
-hseriesops.BREAKING CHANGE: Removed some unused variants from
TK1ConvertErrorandOpConvertError.