Skip to content

Commit 36eb999

Browse files
Regen Qiskit 0.46, 1.1, 1.2-dev; Runtime 0.24, 0.25-dev (#1583)
``` npm run gen-api -- -p qiskit -v 0.46.2 --historical npm run gen-api -- -p qiskit -v 1.1.1 npm run gen-api -- -p qiskit -v 1.2.0-dev --dev npm run gen-api -- -p qiskit-ibm-runtime -v 0.24.1 npm run gen-api -- -p qiskit-ibm-runtime -v 0.25.0-dev --dev ```
1 parent 312b6c6 commit 36eb999

File tree

633 files changed

+3769
-2015
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

633 files changed

+3769
-2015
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"name": "qiskit-ibm-runtime",
3-
"version": "0.24.0"
3+
"version": "0.24.1"
44
}

docs/api/qiskit-ibm-runtime/dev/_toc.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,10 @@
534534
"title": "ResilienceOptionsV2",
535535
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2"
536536
},
537+
{
538+
"title": "SamplerExecutionOptionsV2",
539+
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2"
540+
},
537541
{
538542
"title": "SamplerOptions",
539543
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions"

docs/api/qiskit-ibm-runtime/dev/options.mdx

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -69,22 +69,23 @@ options = Options(transpilation={"initial_layout": [0, 1, 2, 3]})
6969

7070
## Classes
7171

72-
| | |
73-
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
74-
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\*args, \*\*kwargs) | Options for V2 Estimator. |
75-
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\*args, \*\*kwargs) | Options for V2 Sampler. |
76-
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). |
77-
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. |
78-
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. |
79-
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. |
80-
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. |
81-
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. |
82-
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. |
83-
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. |
84-
| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives, used by V1 primitives. |
85-
| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\*args, \*\*kwargs) | Transpilation options. |
86-
| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\*args, \*\*kwargs) | Resilience options for V1 primitives. |
87-
| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\*args, \*\*kwargs) | Execution options for V1 primitives. |
88-
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. |
89-
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. |
72+
| | |
73+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74+
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\*args, \*\*kwargs) | Options for V2 Estimator. |
75+
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\*args, \*\*kwargs) | Options for V2 Sampler. |
76+
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). |
77+
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. |
78+
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. |
79+
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. |
80+
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. |
81+
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. |
82+
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. |
83+
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. |
84+
| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives, used by V1 primitives. |
85+
| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\*args, \*\*kwargs) | Transpilation options. |
86+
| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\*args, \*\*kwargs) | Resilience options for V1 primitives. |
87+
| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\*args, \*\*kwargs) | Execution options for V1 primitives. |
88+
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. |
89+
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. |
90+
| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2")(\*args, \*\*kwargs) | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
9091

docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_runtime.Batch
9595

9696
### backend
9797

98-
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L244-L252" signature="backend()">
98+
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L238-L246" signature="backend()">
9999
Return backend for this session.
100100

101101
**Return type**
@@ -109,7 +109,7 @@ python_api_name: qiskit_ibm_runtime.Batch
109109

110110
### cancel
111111

112-
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L230-L234" signature="cancel()">
112+
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L224-L228" signature="cancel()">
113113
Cancel all pending jobs in a session.
114114

115115
**Return type**
@@ -119,7 +119,7 @@ python_api_name: qiskit_ibm_runtime.Batch
119119

120120
### close
121121

122-
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L236-L242" signature="close()">
122+
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L230-L236" signature="close()">
123123
Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs.
124124

125125
**Return type**
@@ -129,7 +129,7 @@ python_api_name: qiskit_ibm_runtime.Batch
129129

130130
### details
131131

132-
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L281-L323" signature="details()">
132+
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L275-L317" signature="details()">
133133
Return session details.
134134

135135
**Return type**
@@ -158,7 +158,7 @@ python_api_name: qiskit_ibm_runtime.Batch
158158

159159
### from\_id
160160

161-
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L343-L386" signature="from_id(session_id, service=None)" modifiers="classmethod">
161+
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L337-L380" signature="from_id(session_id, service=None)" modifiers="classmethod">
162162
Construct a Session object with a given session\_id
163163

164164
**Parameters**
@@ -186,7 +186,7 @@ python_api_name: qiskit_ibm_runtime.Batch
186186

187187
### run
188188

189-
<Function id="qiskit_ibm_runtime.Batch.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L165-L223" signature="run(program_id, inputs, options=None, callback=None, result_decoder=None)">
189+
<Function id="qiskit_ibm_runtime.Batch.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L159-L217" signature="run(program_id, inputs, options=None, callback=None, result_decoder=None)">
190190
Run a program in the session.
191191

192192
**Parameters**
@@ -207,7 +207,7 @@ python_api_name: qiskit_ibm_runtime.Batch
207207

208208
### status
209209

210-
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L254-L279" signature="status()">
210+
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L248-L273" signature="status()">
211211
Return current session status.
212212

213213
**Return type**

docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator
88

99
# Estimator
1010

11-
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L218-L402">
11+
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L228-L412">
1212
alias of [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1")
1313
</Attribute>
1414

docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1
88

99
# EstimatorV1
1010

11-
<Class id="qiskit_ibm_runtime.EstimatorV1" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L218-L402" signature="EstimatorV1(backend=None, session=None, options=None)" modifiers="class">
11+
<Class id="qiskit_ibm_runtime.EstimatorV1" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L228-L412" signature="EstimatorV1(backend=None, session=None, options=None)" modifiers="class">
1212
Class for interacting with Qiskit Runtime Estimator primitive service.
1313

1414
Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1
9595

9696
### run
9797

98-
<Function id="qiskit_ibm_runtime.EstimatorV1.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L297-L331" signature="run(circuits, observables, parameter_values=None, **kwargs)">
98+
<Function id="qiskit_ibm_runtime.EstimatorV1.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L307-L341" signature="run(circuits, observables, parameter_values=None, **kwargs)">
9999
Submit a request to the estimator primitive.
100100

101101
**Parameters**
@@ -120,7 +120,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1
120120

121121
### set\_options
122122

123-
<Function id="qiskit_ibm_runtime.EstimatorV1.set_options" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L452-L460" signature="set_options(**fields)">
123+
<Function id="qiskit_ibm_runtime.EstimatorV1.set_options" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L426-L434" signature="set_options(**fields)">
124124
Set options values for the sampler.
125125

126126
**Parameters**

docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
88

99
# EstimatorV2
1010

11-
<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L53-L215" signature="EstimatorV2(mode=None, backend=None, session=None, options=None)" modifiers="class">
11+
<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L53-L225" signature="EstimatorV2(mode=None, backend=None, session=None, options=None)" modifiers="class">
1212
Class for interacting with Qiskit Runtime Estimator primitive service.
1313

1414
Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
@@ -125,7 +125,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
125125

126126
### run
127127

128-
<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L170-L187" signature="run(pubs, *, precision=None)">
128+
<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L170-L188" signature="run(pubs, *, precision=None)">
129129
Submit a request to the estimator primitive.
130130

131131
**Parameters**

0 commit comments

Comments
 (0)