Skip to content

Commit 9c2c133

Browse files
Generate Qiskit 2.1.2 and Runtime 0.41.1 (#3762)
1 parent 40c1e06 commit 9c2c133

File tree

126 files changed

+864
-26163
lines changed

Some content is hidden

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

126 files changed

+864
-26163
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.41.0"
3+
"version": "0.41.1"
44
}

docs/api/qiskit-ibm-runtime/qiskit-runtime-service.mdx

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

99
# QiskitRuntimeService
1010

11-
<Class id="qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L49-L1228" signature="QiskitRuntimeService(*args, **kwargs)" modifiers="class">
11+
<Class id="qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L49-L1241" signature="QiskitRuntimeService(*args, **kwargs)" modifiers="class">
1212
Bases: `object`
1313

1414
Class for interacting with the Qiskit Runtime service.
@@ -75,7 +75,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
7575

7676
### active\_account
7777

78-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L622-L628" signature="active_account()">
78+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L621-L627" signature="active_account()">
7979
Return the IBM Quantum account currently in use for the session.
8080

8181
**Returns**
@@ -89,7 +89,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
8989

9090
### active\_instance
9191

92-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_instance" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1207-L1209" signature="active_instance()">
92+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_instance" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1220-L1222" signature="active_instance()">
9393
Return the crn of the current active instance.
9494

9595
**Return type**
@@ -99,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
9999

100100
### backend
101101

102-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L744-L782" signature="backend(name, instance=None, use_fractional_gates=False)">
102+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L743-L781" signature="backend(name, instance=None, use_fractional_gates=False)">
103103
Return a single backend matching the specified filtering.
104104

105105
**Parameters**
@@ -123,7 +123,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
123123

124124
### backends
125125

126-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L403-L509" signature="backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)">
126+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L402-L508" signature="backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)">
127127
Return all backends accessible via this account, subject to optional filtering.
128128

129129
**Parameters**
@@ -184,7 +184,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
184184

185185
### check\_pending\_jobs
186186

187-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1105-L1140" signature="check_pending_jobs()">
187+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1104-L1139" signature="check_pending_jobs()">
188188
(DEPRECATED) Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached.
189189

190190
**Return type**
@@ -194,7 +194,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
194194

195195
### delete\_account
196196

197-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L630-L648" signature="delete_account(filename=None, name=None, channel=None)" modifiers="static">
197+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L629-L647" signature="delete_account(filename=None, name=None, channel=None)" modifiers="static">
198198
Delete a saved account from disk.
199199

200200
**Parameters**
@@ -214,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
214214

215215
### delete\_job
216216

217-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1005-L1030" signature="delete_job(job_id)">
217+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1004-L1029" signature="delete_job(job_id)">
218218
(DEPRECATED) Delete a runtime job.
219219

220220
Note that this operation cannot be reversed.
@@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
235235

236236
### instances
237237

238-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.instances" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1196-L1205" signature="instances()">
238+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.instances" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1209-L1218" signature="instances()">
239239
**Return a list that contains a series of dictionaries with the**
240240

241241
following instance identifiers per instance: “crn”, “plan”, “name”.
@@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
251251

252252
### job
253253

254-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L879-L910" signature="job(job_id)">
254+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L878-L909" signature="job(job_id)">
255255
Retrieve a runtime job.
256256

257257
**Parameters**
@@ -274,7 +274,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
274274

275275
### jobs
276276

277-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L912-L1003" signature="jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)">
277+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L911-L1002" signature="jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)">
278278
Retrieve all runtime jobs, subject to optional filtering.
279279

280280
**Parameters**
@@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
306306

307307
### least\_busy
308308

309-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1142-L1194" signature="least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)">
309+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1141-L1207" signature="least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)">
310310
Return the least busy available backend.
311311

312312
**Parameters**
@@ -340,7 +340,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
340340

341341
### save\_account
342342

343-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.save_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L650-L712" signature="save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False, region=None, plans_preference=None, tags=None)" modifiers="static">
343+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.save_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L649-L711" signature="save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False, region=None, plans_preference=None, tags=None)" modifiers="static">
344344
Save the account to disk for future use.
345345

346346
**Parameters**
@@ -367,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
367367

368368
### saved\_accounts
369369

370-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L714-L742" signature="saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers="static">
370+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L713-L741" signature="saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers="static">
371371
List the accounts saved on disk.
372372

373373
**Parameters**
@@ -392,7 +392,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
392392

393393
### usage
394394

395-
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1032-L1046" signature="usage()">
395+
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1031-L1045" signature="usage()">
396396
Return usage information for the current active instance.
397397

398398
**Returns**

0 commit comments

Comments
 (0)