PrimitivesV2 schemas #14

gadial · 2024-02-28T12:11:15Z

Summary

This PR adds schemas for input for V2 primitives (EstimatorV2/SamplerV2) which rely on qiskit.primitives.containers for data passing.

Addresses #121

schemas/estimator_v2_schema.json

jyu00 · 2024-03-12T17:57:05Z

schemas/estimator_v2_schema.json

+                        }
+                    }
+                },
+                "resilience_level": {


resilience_level is not inside options

schemas/estimator_v2_schema.json

schemas/sampler_v2_schema.json

Co-authored-by: Jessie Yu <[email protected]>

jyu00

Can you also add support_qiskit? Just so we don't have to make that update later.

Note that we should make the schema as descriptive as possible, since we got a lot of questions on using the REST API.

jyu00 · 2024-03-25T18:28:03Z

schemas/estimator_v2_schema.json

+                "minItems": 2,
+                "prefixItems": [
+                    {"description": "The quantum circuit in base64-encoded QPY format. See https://docs.quantum.ibm.com/api/qiskit/qpy for more details on QPY.", "type": "object"},
+                    {"description": "One or more observables.", "type": "array"},


It'd be helpful to point out the array elements need to be strings and/or show an example in the description.

schemas/estimator_v2_schema.json

schemas/sampler_v2_schema.json

schemas/estimator_v2_schema.json

schemas/sampler_v2_schema.json

jyu00 · 2024-04-02T16:18:21Z

@gadial Can you also add some tests?

Co-authored-by: Jessie Yu <[email protected]>

… of noise factors (currently disagrees with `EstimatorOptions` on behaviour in case of empty noise factor list)

…sure_noise_mitigation implies measure_noise_mitigation=True

…tion=True` if `pec` options are used

axelhzf · 2024-05-14T14:12:49Z

schemas/sampler_v2_schema.json

+                "type": "array",
+                "minItems": 1,
+                "prefixItems": [
+                    {"description": "The quantum circuit in QASM string or base64-encoded QPY format. See https://docs.quantum.ibm.com/api/qiskit/qpy for more details on QPY.", "type": "object"},


I think this type should be an object or a string (for the qasm string case)

Done in b9f86871958419765806ec4e41c2810d75351fc5

jyu00 · 2024-04-30T15:18:30Z

requirements-dev.txt

@@ -2,3 +2,4 @@ fastjsonschema
 jsonschema
 jsonschema-rs
 ddt
+qiskit-ibm-runtime@git+https://[email protected]/Qiskit/qiskit-ibm-runtime.git


Any reason we want to install from main branch and not just the latest release?

Originally it was qiskit-ibm-runtime>=0.22 but I changed it because we had test failures due to obsolete code. I tried switching to 0.23 and had a similar problem now. That's because of small errors in qiskit-ibm-runtime which I already fixed (e.g. it considered value of 0 for a pec-option as boolean False and so did not check whether the enable-pec option is True. Really minor stuff.

schemas/sampler_v2_schema.json

gadial added 5 commits February 28, 2024 14:07

Partial version of EstimatorV2 input schema

ffd2781

Full EstimatorV2 schema

183b361

Added SamplerV2 schema and added seed_estimator to estimator schema

299d7c2

Updating the estimator schema after options changes in qiskit runtime

377e168

Updated SamplerV2 schema

3e046dd

jyu00 requested changes Mar 12, 2024

View reviewed changes

gadial and others added 4 commits March 13, 2024 09:04

Update schemas/estimator_v2_schema.json

c565ff8

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

1849443

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

18af181

Co-authored-by: Jessie Yu <[email protected]>

Fixes according to PR review

aed9bbe

jyu00 reviewed Mar 25, 2024

View reviewed changes

gadial and others added 18 commits April 3, 2024 09:28

Update schemas/estimator_v2_schema.json

bcf6256

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

337867e

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

8d946fa

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

82609b6

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/sampler_v2_schema.json

255fcd7

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/sampler_v2_schema.json

1886b62

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

141f86c

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

158e3ff

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

a63eb71

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

1c1e6f8

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

126276d

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

e3c233b

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

3f284dc

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

9ce0aeb

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

5ccb378

Co-authored-by: Jessie Yu <[email protected]>

Update schemas/estimator_v2_schema.json

420d814

Co-authored-by: Jessie Yu <[email protected]>

Starting to add tests

55a7c67

Added a framework to test schema vs runtime validator

6913d3d

gadial added 19 commits April 4, 2024 15:24

Test for resilience boolean values and schema fix based on the test

7c1b9fc

Tests for zne options; extended the schema to validate correct number…

e3ff48a

… of noise factors (currently disagrees with `EstimatorOptions` on behaviour in case of empty noise factor list)

Improving the test framework

ce5231b

Updated the schema to verify zne implies zne_mitigation=True, and mea…

5b117e3

…sure_noise_mitigation implies measure_noise_mitigation=True

Added pec options tests and updated the schema to require `pec_mitiga…

0b361c3

…tion=True` if `pec` options are used

Added noise learning tests

520983b

Added execution and twirling tests

ca09808

Added Sampler tests

2cd2681

linting

5cb7635

Schema fix: noise_gain is inclusive minimum

16f4322

Added default shots/precision

7387a4b

Added support_qiskit

24579c4

Additional data on PUBS

7983a03

Allow longer line length with flake8

34a6cb4

linting

74e3c83

Switching to test against the main branch of qiskit-ibm-runtime

167a74d

use https instead of ssh

ab2c1d4

Fixes

1441aa2

Fixes

7687e6e

gadial requested a review from jyu00 April 28, 2024 12:59

axelhzf reviewed May 14, 2024

View reviewed changes

jyu00 reviewed May 20, 2024

View reviewed changes

jyu00 and others added 3 commits May 20, 2024 10:54

Fix shots

7335f96

Added meas_type to Sampler schema

f6304e8

QuantumCircuit can be either object or string

b9f8687

jyu00 reviewed May 21, 2024

View reviewed changes

schemas/sampler_v2_schema.json Outdated Show resolved Hide resolved

Change back to shots

bbf4bd9

jyu00 approved these changes May 21, 2024

View reviewed changes

jyu00 merged commit db62121 into Qiskit:main May 21, 2024
3 checks passed

gadial deleted the primitives_schemas branch May 22, 2024 05:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PrimitivesV2 schemas #14

PrimitivesV2 schemas #14

gadial commented Feb 28, 2024 •

edited

Loading

jyu00 Mar 12, 2024

gadial Mar 13, 2024

jyu00 left a comment •

edited

Loading

jyu00 Mar 25, 2024

jyu00 commented Apr 2, 2024

axelhzf May 14, 2024

gadial May 21, 2024

jyu00 Apr 30, 2024

gadial May 21, 2024 •

edited

Loading

PrimitivesV2 schemas #14

PrimitivesV2 schemas #14

Conversation

gadial commented Feb 28, 2024 • edited Loading

Summary

jyu00 Mar 12, 2024

Choose a reason for hiding this comment

gadial Mar 13, 2024

Choose a reason for hiding this comment

jyu00 left a comment • edited Loading

Choose a reason for hiding this comment

jyu00 Mar 25, 2024

Choose a reason for hiding this comment

jyu00 commented Apr 2, 2024

axelhzf May 14, 2024

Choose a reason for hiding this comment

gadial May 21, 2024

Choose a reason for hiding this comment

jyu00 Apr 30, 2024

Choose a reason for hiding this comment

gadial May 21, 2024 • edited Loading

Choose a reason for hiding this comment

gadial commented Feb 28, 2024 •

edited

Loading

jyu00 left a comment •

edited

Loading

gadial May 21, 2024 •

edited

Loading