diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json index b8b932d94ec7..5ed3926890f6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_toc.json +++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json @@ -1318,6 +1318,81 @@ } ] }, + { + "title": "ibm_quantum_schemas.executor.version_2_0", + "untranslatable": true, + "children": [ + { + "title": "Module overview", + "url": "/docs/api/qiskit-ibm-runtime/dev/executor-2-0" + }, + { + "title": "ChunkPart", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-part", + "untranslatable": true + }, + { + "title": "ChunkSpan", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-span", + "untranslatable": true + }, + { + "title": "CircuitItemModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-circuit-item-model", + "untranslatable": true + }, + { + "title": "ItemMetadataModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-item-metadata-model", + "untranslatable": true + }, + { + "title": "MetadataModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-metadata-model", + "untranslatable": true + }, + { + "title": "OptionsModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-options-model", + "untranslatable": true + }, + { + "title": "ParamsModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-params-model", + "untranslatable": true + }, + { + "title": "QuantumProgramModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-model", + "untranslatable": true + }, + { + "title": "QuantumProgramResultItemModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-item-model", + "untranslatable": true + }, + { + "title": "QuantumProgramResultModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-model", + "untranslatable": true + }, + { + "title": "SamplexItemModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-samplex-item-model", + "untranslatable": true + }, + { + "title": "SchedulerTimingModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model", + "untranslatable": true + }, + { + "title": "StretchValueModel", + "url": "/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-stretch-value-model", + "untranslatable": true + } + ] + }, { "title": "ibm_quantum_schemas.noise_learner_v3.version_0_1", "untranslatable": true, diff --git a/docs/api/qiskit-ibm-runtime/dev/executor-2-0.mdx b/docs/api/qiskit-ibm-runtime/dev/executor-2-0.mdx new file mode 100644 index 000000000000..944d956af061 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/executor-2-0.mdx @@ -0,0 +1,36 @@ +--- +title: version_2_0 (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0 in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: ibm_quantum_schemas.executor.version_2_0 +--- + + + + + +# Executor v2.0 + +`ibm_quantum_schemas.executor.version_2_0` + +Models for `Executor` `v2.0`. + +## Classes + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| [`ParamsModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-params-model "ibm_quantum_schemas.executor.version_2_0.ParamsModel") | A model describing the Executor program inputs. | +| [`QuantumProgramModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-model "ibm_quantum_schemas.executor.version_2_0.QuantumProgramModel") | Model to store a quantum program. | +| [`CircuitItemModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-circuit-item-model "ibm_quantum_schemas.executor.version_2_0.CircuitItemModel") | Execution specifications for a single quantum circuit. | +| [`SamplexItemModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-samplex-item-model "ibm_quantum_schemas.executor.version_2_0.SamplexItemModel") | Execution specifications for a single quantum circuit. | +| [`OptionsModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-options-model "ibm_quantum_schemas.executor.version_2_0.OptionsModel") | Runtime options. | +| [`QuantumProgramResultModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-model "ibm_quantum_schemas.executor.version_2_0.QuantumProgramResultModel") | Result from executing a quantum program. | +| [`QuantumProgramResultItemModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-item-model "ibm_quantum_schemas.executor.version_2_0.QuantumProgramResultItemModel") | Results for a single quantum program item. | +| [`ItemMetadataModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-item-metadata-model "ibm_quantum_schemas.executor.version_2_0.ItemMetadataModel") | Per-item metadata for quantum program results. | +| [`SchedulerTimingModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model "ibm_quantum_schemas.executor.version_2_0.SchedulerTimingModel") | Describes the timing of a scheduled circuit. | +| [`StretchValueModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-stretch-value-model "ibm_quantum_schemas.executor.version_2_0.StretchValueModel") | Describes circuit stretch value resolutions. | +| [`MetadataModel`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-metadata-model "ibm_quantum_schemas.executor.version_2_0.MetadataModel") | Execution metadata. | +| [`ChunkSpan`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-span "ibm_quantum_schemas.executor.version_2_0.ChunkSpan") | Timing information about a single chunk of execution. | +| [`ChunkPart`](/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-part "ibm_quantum_schemas.executor.version_2_0.ChunkPart") | A description of the contents of a single part of an execution chunk. | + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-part.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-part.mdx new file mode 100644 index 000000000000..aa594375b35c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-part.mdx @@ -0,0 +1,90 @@ +--- +title: ChunkPart (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.ChunkPart in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.ChunkPart +--- + + + +# ChunkPart + + + Bases: `BaseModel` + + A description of the contents of a single part of an execution chunk. + + ### element\_range + + + Which elements of the item were executed in this chunk part. + + This range has entries `(start_idx, stop_idx, step)` that slice the flattened shape of the corresponding quantum program item, after the `permutation` has been applied. That is, this part corresponds to the data elements `flatten(permute(arr))[start_idx:stop_idx:step]` for some data array `arr` whose shape matches the corresponding item shape. The lower index is inclusive, the upper index is exclusive, and the step must be positive. + + It should hold that `size == max(0, ceil((stop_idx - start_idx) / step))`. + + **Validated by** + + * `cross_validate` + * `must_be_a_valid_range` + + + ### idx\_item + + + The index of an item in a quantum program. + + **Validated by** + + * `cross_validate` + + + ### permutation + + + A permutation vector of the item shape before slicing elements with the `element_range`. + + This list should hold contiguous integers starting at 0, in some order. The convention is that `permuted_shape[i] = shape[permutation[i]]` for every dimension index `i`. + + **Validated by** + + * `cross_validate` + * `must_be_permutation_of_range` + + + ### size + + + The number of elements from the quantum program item that were executed. + + For example, if a quantum program item has shape `(10, 5)`, then it has a total of `50` elements, so that if this `size` is `10`, it constitutes 20% of the total work for the item. + + **Validated by** + + * `cross_validate` + + + ### cross\_validate + + + Check for mutual compatibility of types and shapes of attributes. + + **Return type** + + *Self* + + + ### must\_be\_a\_valid\_range + + + Check that we have a valid range tuple. + + + ### must\_be\_permutation\_of\_range + + + Check that we have a valid permutation vector. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-span.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-span.mdx new file mode 100644 index 000000000000..372d24e5de97 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-chunk-span.mdx @@ -0,0 +1,40 @@ +--- +title: ChunkSpan (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.ChunkSpan in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.ChunkSpan +--- + + + +# ChunkSpan + + + Bases: `BaseModel` + + Timing information about a single chunk of execution. + + + This span may include some amount of non-circuit time. + + + ### parts + + + A description of which parts of a quantum program are contained in this chunk. + + + ### start + + + The start time of the execution chunk in UTC. + + + ### stop + + + The stop time of the execution chunk in UTC. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-circuit-item-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-circuit-item-model.mdx new file mode 100644 index 000000000000..7e1df633a07a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-circuit-item-model.mdx @@ -0,0 +1,50 @@ +--- +title: CircuitItemModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.CircuitItemModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.CircuitItemModel +--- + + + +# CircuitItemModel + + + Bases: `BaseModel` + + Execution specifications for a single quantum circuit. + + The circuit for each item is store separately in `QuantumProgramModel`. + + ### chunk\_size + + + The maximum number circuit arguments to bind to the circuit per shot loop. + + When `"auto"`, the number is chosen server-side with heuristics designed to optimize execution speed. A quantum program must have items where either all chunk sizes are integer-valued, or all chunk sizes are `"auto"`. Integer values are only allowed inside of session exection mode. + + + ### circuit\_arguments + + + Arguments to the parameters of the circuit. + + The last axis is over `circuit.parameters`. Execution broadcasts over the preceding axes; expect one result per element of the leading shape. + + + ### item\_type + + + The type of quantum program item. + + + ### shape + + + The shape of this item. + + This shape must extend (via broadcasting) the implicit shape of the :attr:\~circuit\_arguments\`. The non-trivial axes it introduces represent replications. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-item-metadata-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-item-metadata-model.mdx new file mode 100644 index 000000000000..f4893074dc63 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-item-metadata-model.mdx @@ -0,0 +1,30 @@ +--- +title: ItemMetadataModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.ItemMetadataModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.ItemMetadataModel +--- + + + +# ItemMetadataModel + + + Bases: `BaseModel` + + Per-item metadata for quantum program results. + + ### scheduler\_timing + + + Scheduled circuit timing information, if it is available. + + + ### stretch\_values + + + Stretch value resolution, if it is available. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-metadata-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-metadata-model.mdx new file mode 100644 index 000000000000..50fe1261de2b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-metadata-model.mdx @@ -0,0 +1,24 @@ +--- +title: MetadataModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.MetadataModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.MetadataModel +--- + + + +# MetadataModel + + + Bases: `BaseModel` + + Execution metadata. + + ### chunk\_timing + + + Timing information about all executed chunks of a quantum program. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-options-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-options-model.mdx new file mode 100644 index 000000000000..4441f3dcf035 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-options-model.mdx @@ -0,0 +1,56 @@ +--- +title: OptionsModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.OptionsModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.OptionsModel +--- + + + +# OptionsModel + + + Bases: `BaseModel` + + Runtime options. + + ### experimental + + + Experimental options. + + These options are not guaranteed to be stable and may change or be removed without notice. + + + ### init\_qubits + + + Whether to reset the qubits to the ground state for each shot. + + + ### rep\_delay + + + The repetition delay. + + This is the delay between the end of one circuit and the start of the next within a shot loop. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. When this value is `None`, the default value `backend.default_rep_delay` is used. + + + ### scheduler\_timing + + + Whether to return circuit schedule timing of each provided quantum circuit. + + Setting this value to true will cause corresponding metadata of every program item to be populated in the returned data. + + + ### stretch\_values + + + Whether to return numeric resolutions of stretches for each provided quantum circuit. + + Setting this value to true will cause corresponding metadata of every program item to be populated in the returned data. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-params-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-params-model.mdx new file mode 100644 index 000000000000..dc69cd961244 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-params-model.mdx @@ -0,0 +1,36 @@ +--- +title: ParamsModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.ParamsModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.ParamsModel +--- + + + +# ParamsModel + + + Bases: [`BaseParamsModel`](ibm-quantum-schemas-common-base-params-model "ibm_quantum_schemas.common.base_params.BaseParamsModel") + + A model describing the Executor program inputs. + + ### options + + + Options for runtime. + + + ### quantum\_program + + + The quantum program to execution. + + + ### schema\_version + + + Version of the params schema being used. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-model.mdx new file mode 100644 index 000000000000..701170a0ee88 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-model.mdx @@ -0,0 +1,120 @@ +--- +title: QuantumProgramModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.QuantumProgramModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.QuantumProgramModel +--- + + + +# QuantumProgramModel + + + Bases: `BaseModel` + + Model to store a quantum program. + + ### circuits + + + One quantum circuit for every element of `items`. + + These are stored outside of `items` to cosituate them inside of one QPY / OpenQASM3 blob. + + **Validated by** + + * `check_chunk_sizes_are_consistent` + * `check_circuit_count_is_consistent` + + + ### items + + + Items of the program. + + **Validated by** + + * `check_chunk_sizes_are_consistent` + * `check_circuit_count_is_consistent` + + + ### meas\_level + + + The level at which to return all classical register measurement results. + + This option sets the return type of all classical registers in all quantum program items and determines whether the raw complex data from low-level measurement devices is discriminated into bits or not. + + > * **“classified”: Classical register data is returned as boolean arrays with the intrinsic shape** + > + > `(num_shots, creg_size)`. + > + > * **“kerneled”: Classical register data is returned as a complex array with the intrinsic shape** + > + > `(num_shots, creg_size)`, where each entry represents an IQ data point (resulting from kerneling the measurement trace) in arbitrary units. + > + > * **“avg\_kerneled”: Classical register data is returned as a complex array with the intrinsic** + > + > shape `(creg_size,)`, where data is equivalent to “kerneled” except additionally averaged over shots. + > + > * “both”: Both classified and kerneled data is returned for every classical register. + + **Validated by** + + * `check_chunk_sizes_are_consistent` + * `check_circuit_count_is_consistent` + + + ### passthrough\_data + + + Arbitrary nested data passed through execution without modification. + + **Validated by** + + * `check_chunk_sizes_are_consistent` + * `check_circuit_count_is_consistent` + + + ### semantic\_role + + + Semantic role indicating how execution results may be post-processed by runtime clients. + + Reserved system values include ‘sampler-v2’ and ‘estimator-v2’, and are subject to change without notice. Third party clients should not set or depend on this value. + + **Validated by** + + * `check_chunk_sizes_are_consistent` + * `check_circuit_count_is_consistent` + + + ### shots + + + The number of shots for each individually bound circuit. + + **Constraints** + + * **ge** = 1 + + **Validated by** + + * `check_chunk_sizes_are_consistent` + * `check_circuit_count_is_consistent` + + + ### check\_chunk\_sizes\_are\_consistent + + + Check that all program items set chunk sizes consistently. + + + ### check\_circuit\_count\_is\_consistent + + + Check that there is one circuit for every item. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-item-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-item-model.mdx new file mode 100644 index 000000000000..7d6a2ceef955 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-item-model.mdx @@ -0,0 +1,30 @@ +--- +title: QuantumProgramResultItemModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.QuantumProgramResultItemModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.QuantumProgramResultItemModel +--- + + + +# QuantumProgramResultItemModel + + + Bases: `BaseModel` + + Results for a single quantum program item. + + ### metadata + + + Metadata pertaining to the execution of this particular quantum program item. + + + ### results + + + A map from results to their tensor values. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-model.mdx new file mode 100644 index 000000000000..2594efcf2bed --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-quantum-program-result-model.mdx @@ -0,0 +1,50 @@ +--- +title: QuantumProgramResultModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.QuantumProgramResultModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.QuantumProgramResultModel +--- + + + +# QuantumProgramResultModel + + + Bases: `BaseModel` + + Result from executing a quantum program. + + ### data + + + Resulting data for each quantum program item. + + + ### metadata + + + Execution metadata pertaining to the job as a whole. + + + ### passthrough\_data + + + Arbitrary nested data passed through execution without modification. + + + ### schema\_version + + + Schema version of the result type. + + + ### semantic\_role + + + Semantic role indicating how execution results may be post-processed by runtime clients. + + Reserved system values include ‘sampler-v2’ and ‘estimator-v2’, and are subject to change without notice. Third party clients should not set or depend on this value. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-samplex-item-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-samplex-item-model.mdx new file mode 100644 index 000000000000..18f3bc71e817 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-samplex-item-model.mdx @@ -0,0 +1,54 @@ +--- +title: SamplexItemModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.SamplexItemModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.SamplexItemModel +--- + + + +# SamplexItemModel + + + Bases: `BaseModel` + + Execution specifications for a single quantum circuit. + + The circuit for each item is store separately in `QuantumProgramModel`. + + ### chunk\_size + + + The maximum number circuit arguments to bind to the circuit per shot loop. + + When `"auto"`, the number is chosen server-side with heuristics designed to optimize execution speed. A quantum program must have items where either all chunk sizes are integer-valued, or all chunk sizes are `"auto"`. Integer values are only allowed inside of session exection mode. + + + ### item\_type + + + The type of quantum program item. + + + ### samplex + + + A JSON-encoded samplex. + + + ### samplex\_arguments + + + Arguments to the samplex. + + + ### shape + + + The shape of this item. + + This shape must extend (via broadcasting) the implicit shape of the :attr:\~samplex\_arguments\`. The non-trivial axes it introduces enumerate randomizations. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model.mdx new file mode 100644 index 000000000000..72a6c80b1d90 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model.mdx @@ -0,0 +1,32 @@ +--- +title: SchedulerTimingModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.SchedulerTimingModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.SchedulerTimingModel +--- + + + +# SchedulerTimingModel + + + Bases: `BaseModel` + + Describes the timing of a scheduled circuit. + + All timing information is expressed in terms of multiples of the quantity `dt`, time step duration of the control electronics, which can be queried in backend and target properties. + + ### circuit\_duration + + + The duration of the circuit in `dt` steps. + + + ### timing + + + A description of circuit timing in a comma-separated text format. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-stretch-value-model.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-stretch-value-model.mdx new file mode 100644 index 000000000000..d78dde3a8c77 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas-executor-version-2-0-stretch-value-model.mdx @@ -0,0 +1,46 @@ +--- +title: StretchValueModel (dev version) +description: API reference for ibm_quantum_schemas.executor.version_2_0.StretchValueModel in the dev version of qiskit-ibm-runtime +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: ibm_quantum_schemas.executor.version_2_0.StretchValueModel +--- + + + +# StretchValueModel + + + Bases: `BaseModel` + + Describes circuit stretch value resolutions. + + All timing information is expressed in terms of multiples of the quantity `dt`, time step duration of the control electronics, which can be queried in backend and target properties. + + ### expanded\_values + + + A sequence of pairs `(time, duration)` indicating the time and duration of each delay. + + All units are `dt`, where the `time` denotes the absolute time of a delay in the circuit schedule, and the `duration` denotes the total duration of the delay. + + + ### name + + + The name of the stretch. + + + ### remainder + + + The time left over if `value` were to be used each stretch, in units of `dt`. + + + ### value + + + The resolved stretch value, up to the remainder, in units of `dt`. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas.mdx b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas.mdx index ca123cd16953..dba599b564b3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/ibm-quantum-schemas.mdx @@ -20,6 +20,7 @@ The `ibm_quantum_schemas` package contains the `Pydantic` models that describe t * [Executor v0.2 (`ibm_quantum_schemas.executor.version_0_2`)](executor-0-2) * [Executor v1.0 (`ibm_quantum_schemas.executor.version_1_0`)](executor-1-0) * [Executor v1.1 (`ibm_quantum_schemas.executor.version_1_1`)](executor-1-1) +* [Executor v2.0 (`ibm_quantum_schemas.executor.version_2_0`)](executor-2-0) * [NoiseLearnerV3 v0.1 (`ibm_quantum_schemas.noise_learner_v3.version_0_1`)](noise-learner-v3-0-1) * [NoiseLearnerV3 v0.2 (`ibm_quantum_schemas.noise_learner_v3.version_0_2`)](noise-learner-v3-0-2) * [NoiseLearnerV3 v0.3 (`ibm_quantum_schemas.noise_learner_v3.version_0_3`)](noise-learner-v3-0-3) diff --git a/docs/api/qiskit-ibm-runtime/dev/options-models-post-selection-options.mdx b/docs/api/qiskit-ibm-runtime/dev/options-models-post-selection-options.mdx index cc0922073302..c574c5933030 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options-models-post-selection-options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options-models-post-selection-options.mdx @@ -39,7 +39,7 @@ python_api_name: qiskit_ibm_runtime.options_models.PostSelectionOptions **Constraints** - * **func** = \ + * **func** = \ ### strategy diff --git a/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-to-mid-circuit-measure.mdx b/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-to-mid-circuit-measure.mdx index dfac5aa6d7db..0c52e708320e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-to-mid-circuit-measure.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-to-mid-circuit-measure.mdx @@ -8,23 +8,25 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertToMidCircuitMeasure # ConvertToMidCircuitMeasure - + Bases: [`TransformationPass`](/docs/api/qiskit/qiskit.transpiler.TransformationPass) - Transpiler pass replacing mid-circuit terminal measure instructions. + Transpiler pass replacing mid-circuit measure instructions. Transpiler pass that replaces terminal measure instructions in non-terminal locations with `MidCircuitMeasure` instructions. By default, these will be `measure_2`, but the pass accepts custom `measure_` definitions. This pass is expected to run after routing, as it will check that `MidCircuitMeasure` is supported in the corresponding physical qubit. - Note that the pass will only act on non-terminal `Measure` instances, and won’t replace existing mid-circuit measurement instructions (e.g., `"measure_2" -> "measure_3"`) or convert any `MidCircuitMeasure` instance into a `Measure`. + This pass is similar to `ConvertToMidCircuitResetAndMeasure` but only handles measurements, not resets. It internally calls `ConvertToMidCircuitResetAndMeasure` with a no-op reset name. + + Note that the pass will only act on non-terminal `measure` instances, and won’t replace existing mid-circuit measurement instructions (e.g., `"measure_2" -> "measure_3"`) or convert any `MidCircuitMeasure` instance into a `Measure`. **Parameters** - * **target** – Backend’s target instance that contains one or more `measure_` instructions. - * **mcm\_name** – Name of the `measure_` instruction that terminal measure instructions in non-terminal locations will be replaced with. This instruction must be contained in the target. Defaults to `measure_2`. + * **target** – Backend’s target instance. + * **mcm\_name** – Name of the instruction used to replace non-terminal Measure instructions. The name must start with “measure”, and the instruction must be contained in the target. The default name is `measure_2`. **Raises** - **ValueError** – If the specifcied `mcm_name` does not conform to the `measure_` pattern or is not contained in the provided target. + **ValueError** – If the specified `mcm_name` does not start with `measure` or is not contained in the provided target. ## Attributes @@ -97,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertToMidCircuitMeasure ### run - + Run the pass on a dag. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx b/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx index e7329275ed26..7c0681c4c869 100644 --- a/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx @@ -21,7 +21,7 @@ A collection of transpiler passes. Refer to [/guides/transpile](/docs/guides/tra | [`ConvertIdToDelay`](/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-id-to-delay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay") | Convert `qiskit.circuit.library.standard_gates.IGate` to a corresponding delay. | | [`ConvertISAToClifford`](/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-isa-to-clifford "qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford") | Convert the gates of an ISA circuit to Clifford gates. | | [`FoldRzzAngle`](/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-fold-rzz-angle "qiskit_ibm_runtime.transpiler.passes.FoldRzzAngle") | Fold Rzz gate angle into calibrated range of 0-pi/2 with local gate tweaks. | -| [`ConvertToMidCircuitMeasure`](/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-to-mid-circuit-measure "qiskit_ibm_runtime.transpiler.passes.ConvertToMidCircuitMeasure") | Transpiler pass replacing mid-circuit terminal measure instructions. | +| [`ConvertToMidCircuitMeasure`](/docs/api/qiskit-ibm-runtime/dev/transpiler-passes-convert-to-mid-circuit-measure "qiskit_ibm_runtime.transpiler.passes.ConvertToMidCircuitMeasure") | Transpiler pass replacing mid-circuit measure instructions. | See [`qiskit_ibm_runtime.transpiler.passes.scheduling`](transpiler-passes-scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") for a collection of scheduling passes. diff --git a/public/docs/api/qiskit-ibm-runtime/dev/objects.inv b/public/docs/api/qiskit-ibm-runtime/dev/objects.inv index 95338b92579b..5818483243c0 100644 Binary files a/public/docs/api/qiskit-ibm-runtime/dev/objects.inv and b/public/docs/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif index 258c66d0f128..854a65384fde 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif index 28d08ff9288a..41e3360d31d6 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif index 4f7478a67b37..a297b15f8d43 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif index df27a343e36a..06a7e42ec564 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif b/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif index 92c9a63bf4c7..ac438323bb16 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif index 500a2d2b9139..4fc152184dc8 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif index 28b38a0e980a..a8bed349e847 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif index d6ba473cab63..fd6d39c39f9e 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif index 78dace4f39e5..a3148bd46e49 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif index 0c8b7e43ffcd..8d259d268e82 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-1.avif b/public/docs/images/api/qiskit/dev/visualization-1.avif index 5e272b6149ca..f61bae2dbdeb 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-1.avif and b/public/docs/images/api/qiskit/dev/visualization-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-3.avif b/public/docs/images/api/qiskit/dev/visualization-3.avif index 8509e7e333d9..242e32f0caf9 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-3.avif and b/public/docs/images/api/qiskit/dev/visualization-3.avif differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index 7c78c2f185a0..e502e80f4027 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -37,7 +37,7 @@ "0.19": "https://ibm.box.com/shared/static/wjoea4x5tnxd0l4lgo2v3kxnx6btxvvl.zip" }, "qiskit-ibm-runtime": { - "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/8943998958/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/9009582793/zip", "0.48": "https://ibm.box.com/shared/static/w5yy54rxg8zspe8bxueknastn9cw8nfe.zip", "0.47": "https://ibm.box.com/shared/static/68x7u8qpr72id254w6hnjbgo7317hwjk.zip", "0.46": "https://ibm.box.com/shared/static/p2jntzpdwqa75i75d0sm5ltzbaaw5ksa.zip", diff --git a/scripts/config/historical-pages-to-latest.json b/scripts/config/historical-pages-to-latest.json index 7a306fbc6348..4fe1ad8e37bb 100644 --- a/scripts/config/historical-pages-to-latest.json +++ b/scripts/config/historical-pages-to-latest.json @@ -1531,10 +1531,24 @@ "utils-noise-learner-result-pauli-lindblad-error": "/" }, "dev": { + "executor-2-0": "/", "ibm-quantum-schemas-common-compressed-qpy-data-model": "/", "ibm-quantum-schemas-common-compressed-tensor-model": "/", "ibm-quantum-schemas-common-f-64-compressed-tensor-model": "/", "ibm-quantum-schemas-common-open-qasm-3-data-model": "/", + "ibm-quantum-schemas-executor-version-2-0-chunk-part": "/", + "ibm-quantum-schemas-executor-version-2-0-chunk-span": "/", + "ibm-quantum-schemas-executor-version-2-0-circuit-item-model": "/", + "ibm-quantum-schemas-executor-version-2-0-item-metadata-model": "/", + "ibm-quantum-schemas-executor-version-2-0-metadata-model": "/", + "ibm-quantum-schemas-executor-version-2-0-options-model": "/", + "ibm-quantum-schemas-executor-version-2-0-params-model": "/", + "ibm-quantum-schemas-executor-version-2-0-quantum-program-model": "/", + "ibm-quantum-schemas-executor-version-2-0-quantum-program-result-item-model": "/", + "ibm-quantum-schemas-executor-version-2-0-quantum-program-result-model": "/", + "ibm-quantum-schemas-executor-version-2-0-samplex-item-model": "/", + "ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model": "/", + "ibm-quantum-schemas-executor-version-2-0-stretch-value-model": "/", "ibm-quantum-schemas-noise-learner-v3-version-0-3-bit-flip-checks-options-model": "/", "ibm-quantum-schemas-noise-learner-v3-version-0-3-linbdblad-result-metadata-model": "/", "ibm-quantum-schemas-noise-learner-v3-version-0-3-linbdblad-result-post-selection-metadata-model": "/",