Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions docs/api/qiskit-ibm-runtime/dev/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
36 changes: 36 additions & 0 deletions docs/api/qiskit-ibm-runtime/dev/executor-2-0.mdx
Original file line number Diff line number Diff line change
@@ -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
---

<span id="executor-v2-0-ibm-quantum-schemas-executor-version-2-0" />

<span id="module-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. |

Original file line number Diff line number Diff line change
@@ -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
---

<span id="ibm-quantum-schemas-executor-version-2-0-chunkpart" />

# ChunkPart

<Class id="ibm_quantum_schemas.executor.version_2_0.ChunkPart" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L291-L349" signature="ChunkPart" modifiers="pydantic model">
Bases: `BaseModel`

A description of the contents of a single part of an execution chunk.

### element\_range

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.element_range" attributeTypeHint="tuple[int, int, int] [Required]" modifiers="field">
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`
</Attribute>

### idx\_item

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.idx_item" attributeTypeHint="int [Required]" modifiers="field">
The index of an item in a quantum program.

**Validated by**

* `cross_validate`
</Attribute>

### permutation

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.permutation" attributeTypeHint="list[int] [Required]" modifiers="field">
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`
</Attribute>

### size

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.size" attributeTypeHint="int [Required]" modifiers="field">
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`
</Attribute>

### cross\_validate

<Function id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.cross_validate" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L340-L349" signature="cross_validate" modifiers="validator">
Check for mutual compatibility of types and shapes of attributes.

**Return type**

*Self*
</Function>

### must\_be\_a\_valid\_range

<Function id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.must_be_a_valid_range" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L331-L338" signature="must_be_a_valid_range" modifiers="validator">
Check that we have a valid range tuple.
</Function>

### must\_be\_permutation\_of\_range

<Function id="ibm_quantum_schemas.executor.version_2_0.ChunkPart.must_be_permutation_of_range" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L323-L329" signature="must_be_permutation_of_range" modifiers="validator">
Check that we have a valid permutation vector.
</Function>
</Class>

Original file line number Diff line number Diff line change
@@ -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
---

<span id="ibm-quantum-schemas-executor-version-2-0-chunkspan" />

# ChunkSpan

<Class id="ibm_quantum_schemas.executor.version_2_0.ChunkSpan" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L352-L367" signature="ChunkSpan" modifiers="pydantic model">
Bases: `BaseModel`

Timing information about a single chunk of execution.

<Admonition title="Note" type="note">
This span may include some amount of non-circuit time.
</Admonition>

### parts

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkSpan.parts" attributeTypeHint="list[ChunkPart] [Required]" attributeTypeHintHref="ibm-quantum-schemas-executor-version-2-0-chunk-part" modifiers="field">
A description of which parts of a quantum program are contained in this chunk.
</Attribute>

### start

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkSpan.start" attributeTypeHint="datetime.datetime [Required]" modifiers="field">
The start time of the execution chunk in UTC.
</Attribute>

### stop

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ChunkSpan.stop" attributeTypeHint="datetime.datetime [Required]" modifiers="field">
The stop time of the execution chunk in UTC.
</Attribute>
</Class>

Original file line number Diff line number Diff line change
@@ -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
---

<span id="ibm-quantum-schemas-executor-version-2-0-circuititemmodel" />

# CircuitItemModel

<Class id="ibm_quantum_schemas.executor.version_2_0.CircuitItemModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L101-L131" signature="CircuitItemModel" modifiers="pydantic model">
Bases: `BaseModel`

Execution specifications for a single quantum circuit.

The circuit for each item is store separately in `QuantumProgramModel`.

### chunk\_size

<Attribute id="ibm_quantum_schemas.executor.version_2_0.CircuitItemModel.chunk_size" attributeTypeHint="Annotated[int, Field(ge" attributeValue="1)] | Literal['auto'] = 'auto'" modifiers="field">
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.
</Attribute>

### circuit\_arguments

<Attribute id="ibm_quantum_schemas.executor.version_2_0.CircuitItemModel.circuit_arguments" attributeTypeHint="F64CompressedTensorModel [Required]" attributeTypeHintHref="ibm-quantum-schemas-common-f-64-compressed-tensor-model" modifiers="field">
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.
</Attribute>

### item\_type

<Attribute id="ibm_quantum_schemas.executor.version_2_0.CircuitItemModel.item_type" attributeTypeHint="Literal['circuit']" attributeValue="'circuit'" modifiers="field">
The type of quantum program item.
</Attribute>

### shape

<Attribute id="ibm_quantum_schemas.executor.version_2_0.CircuitItemModel.shape" attributeTypeHint="list[int] [Required]" modifiers="field">
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.
</Attribute>
</Class>

Original file line number Diff line number Diff line change
@@ -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
---

<span id="ibm-quantum-schemas-executor-version-2-0-itemmetadatamodel" />

# ItemMetadataModel

<Class id="ibm_quantum_schemas.executor.version_2_0.ItemMetadataModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L271-L278" signature="ItemMetadataModel" modifiers="pydantic model">
Bases: `BaseModel`

Per-item metadata for quantum program results.

### scheduler\_timing

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ItemMetadataModel.scheduler_timing" attributeTypeHint="SchedulerTimingModel | None" attributeTypeHintHref="ibm-quantum-schemas-executor-version-2-0-scheduler-timing-model" attributeValue="None" modifiers="field">
Scheduled circuit timing information, if it is available.
</Attribute>

### stretch\_values

<Attribute id="ibm_quantum_schemas.executor.version_2_0.ItemMetadataModel.stretch_values" attributeTypeHint="list[StretchValueModel] | None" attributeTypeHintHref="ibm-quantum-schemas-executor-version-2-0-stretch-value-model" attributeValue="None" modifiers="field">
Stretch value resolution, if it is available.
</Attribute>
</Class>

Original file line number Diff line number Diff line change
@@ -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
---

<span id="ibm-quantum-schemas-executor-version-2-0-metadatamodel" />

# MetadataModel

<Class id="ibm_quantum_schemas.executor.version_2_0.MetadataModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10.20260723/ibm_quantum_schemas/executor/version_2_0/models.py#L370-L374" signature="MetadataModel" modifiers="pydantic model">
Bases: `BaseModel`

Execution metadata.

### chunk\_timing

<Attribute id="ibm_quantum_schemas.executor.version_2_0.MetadataModel.chunk_timing" attributeTypeHint="list[ChunkSpan] [Required]" attributeTypeHintHref="ibm-quantum-schemas-executor-version-2-0-chunk-span" modifiers="field">
Timing information about all executed chunks of a quantum program.
</Attribute>
</Class>

Loading
Loading