Add JSON serialization support for NoiseModel classes #7396

WingCode · 2025-05-30T17:34:17Z

This adds JSON serialization support and in most cases genuine repr support for

cirq.contrib.noise_models.DampedReadoutNoiseModel
cirq.contrib.noise_models.DepolarizingNoiseModel
cirq.contrib.noise_models.DepolarizingWithDampedReadoutNoiseModel
cirq.contrib.noise_models.DepolarizingWithReadoutNoiseModel
cirq.contrib.noise_models.ReadoutNoiseModel
cirq.devices.noise_properties.NoiseModelFromNoiseProperties
cirq.devices.thermal_noise_model.ThermalNoiseModel
cirq_google.experimental.noise_models.noise_models.PerQubitDepolarizingWithDampedReadoutNoiseModel

Also adds cirq.contrib.json_test_data for test data files specific to the classes in cirq.contrib module.

pavoljuhas · 2025-06-05T01:17:00Z

@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 · 2025-06-07T03:08:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.68%. Comparing base (c434f94) to head (ca36452).
Report is 3 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

WingCode · 2025-06-07T20:44:18Z

@pavoljuhas I have fixed the CI checks.

cirq-core/cirq/contrib/noise_models/noise_models.py

pavoljuhas

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.

cirq-core/cirq/json_resolver_cache.py

cirq-core/cirq/protocols/json_test_data/DampedReadoutNoiseModel.json

cirq-core/cirq/protocols/json_test_data/spec.py

cirq-google/cirq_google/experimental/noise_models/noise_models.py

cirq-google/cirq_google/experimental/noise_models/noise_models_test.py

cirq-core/cirq/contrib/__init__.py

cirq-core/cirq/devices/thermal_noise_model.py

cirq-core/cirq/devices/thermal_noise_model_test.py

mhucka · 2025-06-11T16:43:57Z

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.

pavoljuhas

I have not got through all files, but I think we can address the new comments before next iteration.

cirq-core/cirq/contrib/json_test_data/__init__.py

cirq-core/cirq/contrib/json_test_data/spec.py

cirq-core/cirq/contrib/noise_models/noise_models.py

cirq-core/cirq/devices/thermal_noise_model.py

cirq-core/cirq/devices/thermal_noise_model_test.py

Co-authored-by: Pavol Juhas <[email protected]>

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

Sorry about long delay in reviewing. I have pushed in
several changes that addressed the remaining comments.

Thank you for contributing this!

Add JSON serialisations

9a0f8f1

WingCode requested review from wcourtney, vtomole, verult and a team as code owners May 30, 2025 17:34

github-actions bot added the size: M 50< lines changed <250 label May 30, 2025

Add test JSON and fix tests

6c0d9bb

github-actions bot added size: L 250< lines changed <1000 and removed size: M 50< lines changed <250 labels Jun 1, 2025

WingCode and others added 2 commits June 2, 2025 01:15

Fix tests

51d9035

Merge branch 'main' into add-ser-noise-models

bcc575c

mhucka added the unitaryHACK label Jun 3, 2025

mhucka and others added 4 commits June 5, 2025 19:46

Merge branch 'main' into add-ser-noise-models

8da202f

Fix pylint

0643e61

Add tests

e5fa84b

Add tests

4e98a55

WingCode added 2 commits June 7, 2025 13:13

Fix tests

52f72cd

Fix lint

7d29cad

WingCode and others added 4 commits June 9, 2025 22:36

Fix black

edb0c6d

Merge branch 'main' into add-ser-noise-models

2e9bbd9

Merge branch 'main' into add-ser-noise-models

9b8b7fe

Fix lint

b867010

dstrain115 reviewed Jun 10, 2025

View reviewed changes

cirq-core/cirq/contrib/noise_models/noise_models.py Outdated Show resolved Hide resolved

cirq-core/cirq/contrib/noise_models/noise_models.py Outdated Show resolved Hide resolved

pavoljuhas requested changes Jun 11, 2025

View reviewed changes

Merge branch 'main' into add-ser-noise-models

0f06ac3

WingCode mentioned this pull request Jun 11, 2025

NoiseModels are not serializable #3846

Closed

WingCode requested a review from pavoljuhas June 16, 2025 21:08

Merge branch 'quantumlib:main' into add-ser-noise-models

9c02b87

mhucka assigned mhucka and WingCode and unassigned mhucka Jun 17, 2025

pavoljuhas requested changes Jun 17, 2025

View reviewed changes

WingCode and others added 2 commits June 17, 2025 10:37

Update cirq-core/cirq/contrib/json_test_data/__init__.py

2d2af5c

Co-authored-by: Pavol Juhas <[email protected]>

Update cirq-core/cirq/devices/thermal_noise_model_test.py

4bcbb8b

Co-authored-by: Pavol Juhas <[email protected]>

pavoljuhas mentioned this pull request Jul 21, 2025

convert tests in cirq.contrib.json_test to common json test framework #7520

Open

pavoljuhas added 14 commits July 21, 2025 11:30

Merge branch 'main' into amend-7396-json-noise-models

f487d72

Fix ruff ISC001 - implicitly concatenated string literals

6b454c4

Restore cirq.contrib contents as it was before

4a556be

No need to change this interface to support JSON serialization.

Clean up cirq.contrib.json_test_data.spec

c9f7cda

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.

Prefer cache to lru_cache for functions without arguments

e077495

Drop redundant test of ThermalNoiseModel serialization

18f2565

Already tested by the presence of .json and .repr files. Also check if optional rate arguments are skipped when unspecified.

Review cirq.contrib.noise_models

7b00e93

- 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

Review noise_models_test

953ac3c

Drop unnecessary test of JSON serde and test more repr variants.

Keep sorted order in cirq.json_resolver_cache

0b6325a

Revert cirq.protocols.json_test_data.spec

e73c179

Keep sorted order as in main. There was no change otherwise.

Review PerQubitDepolarizingWithDampedReadoutNoiseModel

2c93e87

- store unspecified probabilities as None in JSON - test serde and repr consistency of more instances in a list

Rewrite JSON support of NoiseModelFromNoiseProperties

e0cb347

- 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

pavoljuhas changed the title ~~Add JSON serialisations~~ Add JSON serialization support for NoiseModel classes Jul 21, 2025

pavoljuhas approved these changes Jul 21, 2025

View reviewed changes

pavoljuhas added the priority/before-1.6 Finish before the Cirq 1.6 release label Jul 22, 2025

pavoljuhas added this pull request to the merge queue Jul 22, 2025

Merged via the queue into quantumlib:main with commit 8e8fd80 Jul 22, 2025
35 checks passed

pavoljuhas mentioned this pull request Jul 23, 2025

Include cirq.contrib test JSON files in cirq-core package #7529

Merged

Add JSON serialization support for NoiseModel classes #7396

Add JSON serialization support for NoiseModel classes #7396

Uh oh!

Conversation

WingCode commented May 30, 2025 • edited by pavoljuhas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pavoljuhas commented Jun 5, 2025

Uh oh!

codecov bot commented Jun 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

WingCode commented Jun 7, 2025

Uh oh!

Uh oh!

Uh oh!

pavoljuhas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mhucka commented Jun 11, 2025

Uh oh!

pavoljuhas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pavoljuhas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

WingCode commented May 30, 2025 •

edited by pavoljuhas

Loading

codecov bot commented Jun 7, 2025 •

edited

Loading