Add JSON serialization support for NoiseModel classes#7396
Merged
pavoljuhas merged 42 commits intoquantumlib:mainfrom Jul 22, 2025
Merged
Add JSON serialization support for NoiseModel classes#7396pavoljuhas merged 42 commits intoquantumlib:mainfrom
pavoljuhas merged 42 commits intoquantumlib:mainfrom
Conversation
WingCode
requested review from
a team,
verult,
vtomole and
wcourtney
as code owners
github-actions
bot
added
size: L
Collaborator
|
@WingCode - thank you for working on this. The failing CI checks should give some pointers on what is amiss. Feel free to ask here if you need clarification. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7396 +/- ##
========================================
Coverage 98.68% 98.68%
========================================
Files 1091 1093 +2
Lines 96948 97109 +161
========================================
+ Hits 95674 95835 +161
Misses 1274 1274 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
@pavoljuhas I have fixed the CI checks. |
dstrain115
reviewed
Jun 10, 2025
pavoljuhas
requested changes
Jun 11, 2025
Collaborator
pavoljuhas
left a comment
pavoljuhas
left a comment
There was a problem hiding this comment.
The code for serialization of contrib classes should be moved under cirq.contrib to limit any dependency of non-contrib cirq on cirq.contrib. Please see inline comments for other suggestions.
Contributor
|
FYI that @pavoljuhas is out on jury duty (a mandatory civic obligation in the USA) starting today and possibly more days (depending on unpredictable factors). If he had commented on the PR or this issue before and hasn't responded, that's why. |
Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>
No need to change this interface to support JSON serialization.
Sync resolver cache with the contrib package `_class_resolver_dictionary` and Move previously serializable classes from `should_not_be_serialized` to `tested_elsewhere`. Also add copyright notice.
- do not change public attributes convert them to protected - use proper_repr for gate_durations_ns in repr - exclude optional arguments from repr when unspecified - change json schema to store class constructor arguments instead of object attributes - this allows to create instances in a standard way instead of using `cls.__new__`. - in json store heat, cool, dephase rates as values only to be zipped with qubits in the same order.
Already tested by the presence of .json and .repr files. Also check if optional rate arguments are skipped when unspecified.
- make the new noise-model class attributes read-only - remove unnecessary `_from_json_dict_` methods - test more json serde round trips over a list of instances
Drop unnecessary test of JSON serde and test more repr variants.
Keep sorted order as in main. There was no change otherwise.
- store unspecified probabilities as None in JSON - test serde and repr consistency of more instances in a list
- remove unnecessary methods `repr` and `_from_json_dict_` - test serde round-trip in noise_properties_test with a custom resolver - add NoiseModelFromNoiseProperties to cirq.json_resolver_cache
* Rewrite JSON support of NoiseModelFromNoiseProperties * Review PerQubitDepolarizingWithDampedReadoutNoiseModel * Revert cirq.protocols.json_test_data.spec * Keep sorted order in cirq.json_resolver_cache * Review noise_models_test * Review cirq.contrib.noise_models * Drop redundant test of ThermalNoiseModel serialization * Revisit ThermalNoiseModel serialization * Prefer `cache` to `lru_cache` for functions without arguments * Clean up cirq.contrib.json_test_data.spec * Restore cirq.contrib contents as it was before
pavoljuhas
changed the title
pavoljuhas
approved these changes
Jul 21, 2025
Collaborator
pavoljuhas
left a comment
pavoljuhas
left a comment
There was a problem hiding this comment.
Sorry about long delay in reviewing. I have pushed in
several changes that addressed the remaining comments.
Thank you for contributing this!
This was referenced Aug 5, 2025
This was referenced Jan 12, 2026
Create an Gateset.__ini__ option to accept classically controlled operations
NoureldinYosri/Cirq#267
Closed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 adds JSON serialization support and in most cases genuine
reprsupport forAlso adds
cirq.contrib.json_test_datafor test data files specific to the classes incirq.contribmodule.Fixes #3846