Skip to content

Commit ba86157

Browse files
github-actions[bot]github-actions[bot]
authored
Update API dev docs (#3933)
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent dab14dd commit ba86157

File tree

100 files changed

+1332
-923
lines changed

Some content is hidden

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

100 files changed

+1332
-923
lines changed

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

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@
4040
"title": "RuntimeEncoder",
4141
"url": "/docs/api/qiskit-ibm-runtime/dev/runtime-encoder"
4242
},
43-
{
44-
"title": "RuntimeJob",
45-
"url": "/docs/api/qiskit-ibm-runtime/dev/runtime-job"
46-
},
4743
{
4844
"title": "RuntimeJobV2",
4945
"url": "/docs/api/qiskit-ibm-runtime/dev/runtime-job-v2"
@@ -365,6 +361,47 @@
365361
}
366362
]
367363
},
364+
{
365+
"title": "qiskit_ibm_runtime.models",
366+
"children": [
367+
{
368+
"title": "Module overview",
369+
"url": "/docs/api/qiskit-ibm-runtime/dev/models"
370+
},
371+
{
372+
"title": "BackendConfiguration",
373+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-backend-configuration"
374+
},
375+
{
376+
"title": "BackendProperties",
377+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-backend-properties"
378+
},
379+
{
380+
"title": "BackendStatus",
381+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-backend-status"
382+
},
383+
{
384+
"title": "GateConfig",
385+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-gate-config"
386+
},
387+
{
388+
"title": "GateProperties",
389+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-gate-properties"
390+
},
391+
{
392+
"title": "Nduv",
393+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-nduv"
394+
},
395+
{
396+
"title": "QasmBackendConfiguration",
397+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-qasm-backend-configuration"
398+
},
399+
{
400+
"title": "UchannelLO",
401+
"url": "/docs/api/qiskit-ibm-runtime/dev/models-uchannel-lo"
402+
}
403+
]
404+
},
368405
{
369406
"title": "qiskit_ibm_runtime.noise_learner",
370407
"children": [

‎docs/api/qiskit-ibm-runtime/dev/batch.mdx‎

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

103103
### backend
104104

105-
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L207-L215" signature="backend()">
105+
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L203-L211" signature="backend()">
106106
Return backend for this session.
107107

108108
**Returns**
@@ -116,7 +116,7 @@ python_api_name: qiskit_ibm_runtime.Batch
116116

117117
### cancel
118118

119-
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L193-L197" signature="cancel()">
119+
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L189-L193" signature="cancel()">
120120
Cancel all pending jobs in a session.
121121

122122
**Return type**
@@ -126,7 +126,7 @@ python_api_name: qiskit_ibm_runtime.Batch
126126

127127
### close
128128

129-
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L199-L205" signature="close()">
129+
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L195-L201" signature="close()">
130130
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.
131131

132132
**Return type**
@@ -136,7 +136,7 @@ python_api_name: qiskit_ibm_runtime.Batch
136136

137137
### details
138138

139-
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L260-L304" signature="details()">
139+
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L256-L300" signature="details()">
140140
Return session details.
141141

142142
**Returns**
@@ -165,7 +165,7 @@ python_api_name: qiskit_ibm_runtime.Batch
165165

166166
### from\_id
167167

168-
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L324-L377" signature="from_id(session_id, service)" modifiers="classmethod">
168+
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L320-L373" signature="from_id(session_id, service)" modifiers="classmethod">
169169
Construct a Session object with a given session\_id
170170

171171
**Parameters**
@@ -191,7 +191,7 @@ python_api_name: qiskit_ibm_runtime.Batch
191191

192192
### status
193193

194-
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L217-L242" signature="status()">
194+
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L213-L238" signature="status()">
195195
Return current session status.
196196

197197
**Returns**
@@ -211,7 +211,7 @@ python_api_name: qiskit_ibm_runtime.Batch
211211

212212
### usage
213213

214-
<Function id="qiskit_ibm_runtime.Batch.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L244-L258" signature="usage()">
214+
<Function id="qiskit_ibm_runtime.Batch.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L240-L254" signature="usage()">
215215
Return session usage in seconds.
216216

217217
Session usage is the time from when the first job starts until the session goes inactive, is closed, or when its last job completes, whichever happens last.

‎docs/api/qiskit-ibm-runtime/dev/estimator-v2.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
9393

9494
### backend
9595

96-
<Function id="qiskit_ibm_runtime.EstimatorV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L217-L219" signature="backend()">
96+
<Function id="qiskit_ibm_runtime.EstimatorV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L205-L207" signature="backend()">
9797
Return the backend the primitive query will be run on.
9898

9999
**Return type**

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-algiers.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
200200

201201
**Return type**
202202

203-
*QasmBackendConfiguration*
203+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
204204
</Function>
205205

206206
### properties
@@ -218,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
218218

219219
**Return type**
220220

221-
*BackendProperties*
221+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
222222
</Function>
223223

224224
### qubit\_properties
@@ -325,7 +325,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
325325

326326
**Return type**
327327

328-
*BackendStatus*
328+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
329329
</Function>
330330
</Class>
331331

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-almaden-v2.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
210210

211211
**Return type**
212212

213-
*QasmBackendConfiguration*
213+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
214214
</Function>
215215

216216
### properties
@@ -228,7 +228,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
228228

229229
**Return type**
230230

231-
*BackendProperties*
231+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
232232
</Function>
233233

234234
### qubit\_properties
@@ -335,7 +335,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
335335

336336
**Return type**
337337

338-
*BackendStatus*
338+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
339339
</Function>
340340
</Class>
341341

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-armonk-v2.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
204204

205205
**Return type**
206206

207-
*QasmBackendConfiguration*
207+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
208208
</Function>
209209

210210
### properties
@@ -222,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
222222

223223
**Return type**
224224

225-
*BackendProperties*
225+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
226226
</Function>
227227

228228
### qubit\_properties
@@ -329,7 +329,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
329329

330330
**Return type**
331331

332-
*BackendStatus*
332+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
333333
</Function>
334334
</Class>
335335

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-athens-v2.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
200200

201201
**Return type**
202202

203-
*QasmBackendConfiguration*
203+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
204204
</Function>
205205

206206
### properties
@@ -218,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
218218

219219
**Return type**
220220

221-
*BackendProperties*
221+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
222222
</Function>
223223

224224
### qubit\_properties
@@ -325,7 +325,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
325325

326326
**Return type**
327327

328-
*BackendStatus*
328+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
329329
</Function>
330330
</Class>
331331

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-auckland.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
200200

201201
**Return type**
202202

203-
*QasmBackendConfiguration*
203+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
204204
</Function>
205205

206206
### properties
@@ -218,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
218218

219219
**Return type**
220220

221-
*BackendProperties*
221+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
222222
</Function>
223223

224224
### qubit\_properties
@@ -325,7 +325,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
325325

326326
**Return type**
327327

328-
*BackendStatus*
328+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
329329
</Function>
330330
</Class>
331331

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-belem-v2.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
200200

201201
**Return type**
202202

203-
*QasmBackendConfiguration*
203+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
204204
</Function>
205205

206206
### properties
@@ -218,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
218218

219219
**Return type**
220220

221-
*BackendProperties*
221+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
222222
</Function>
223223

224224
### qubit\_properties
@@ -325,7 +325,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
325325

326326
**Return type**
327327

328-
*BackendStatus*
328+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
329329
</Function>
330330
</Class>
331331

‎docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-boeblingen-v2.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
210210

211211
**Return type**
212212

213-
*QasmBackendConfiguration*
213+
[*QasmBackendConfiguration*](models-qasm-backend-configuration "qiskit_ibm_runtime.models.backend_configuration.QasmBackendConfiguration")
214214
</Function>
215215

216216
### properties
@@ -228,7 +228,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
228228

229229
**Return type**
230230

231-
*BackendProperties*
231+
[*BackendProperties*](models-backend-properties "qiskit_ibm_runtime.models.backend_properties.BackendProperties")
232232
</Function>
233233

234234
### qubit\_properties
@@ -335,7 +335,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
335335

336336
**Return type**
337337

338-
*BackendStatus*
338+
[*BackendStatus*](models-backend-status "qiskit_ibm_runtime.models.backend_status.BackendStatus")
339339
</Function>
340340
</Class>
341341

0 commit comments

Comments
 (0)