Skip to content

Commit

Permalink
Update API dev docs (Qiskit#2431)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
github-actions[bot] and github-actions[bot] authored Dec 5, 2024
1 parent 93d7ff6 commit 5aaf222
Show file tree
Hide file tree
Showing 306 changed files with 1,355 additions and 1,256 deletions.
8 changes: 8 additions & 0 deletions docs/api/qiskit-ibm-runtime/dev/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,14 @@
{
"title": "draw_layer_errors_swarm",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_errors_swarm"
},
{
"title": "draw_zne_evs",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_zne_evs"
},
{
"title": "draw_zne_extrapolators",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_zne_extrapolators"
}
]
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

# IBMBackend

<Class id="qiskit_ibm_runtime.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L75-L914" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L75-L916" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
Bases: [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.3)")

Backend class interfacing with an IBM Quantum backend.
Expand Down Expand Up @@ -472,7 +472,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### get\_translation\_stage\_plugin

<Function id="qiskit_ibm_runtime.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L912-L914" signature="get_translation_stage_plugin()">
<Function id="qiskit_ibm_runtime.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L912-L916" signature="get_translation_stage_plugin()">
Return the default translation stage plugin name for IBM backends.

**Return type**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### acquire\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L376-L389" signature="acquire_channel(qubit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.
Expand All @@ -203,7 +203,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### check\_faulty

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L231-L263" signature="check_faulty(circuit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.

**Parameters**
Expand All @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### configuration

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L227-L229" signature="configuration()">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.

**Return type**
Expand All @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### control\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L391-L411" signature="control_channel(qubits)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit

This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
Expand All @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### defaults

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L211-L225" signature="defaults(refresh=False)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend

**Parameters**
Expand All @@ -272,7 +272,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### drive\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L346-L359" signature="drive_channel(qubit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.
Expand All @@ -292,7 +292,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### measure\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L361-L374" signature="measure_channel(qubit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.
Expand All @@ -312,7 +312,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### properties

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L197-L209" signature="properties(refresh=False)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties

**Parameters**
Expand Down Expand Up @@ -355,7 +355,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### refresh

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L562-L643" signature="refresh(service)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L643" signature="refresh(service)">
Update the data files from its real counterpart

This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
Expand All @@ -380,7 +380,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### run

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L413-L474" signature="run(run_input, **options)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.

This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object.
Expand Down Expand Up @@ -425,7 +425,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### status

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.

**Returns**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### acquire\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L376-L389" signature="acquire_channel(qubit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.
Expand All @@ -213,7 +213,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### check\_faulty

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L231-L263" signature="check_faulty(circuit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.

**Parameters**
Expand All @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### configuration

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L227-L229" signature="configuration()">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.

**Return type**
Expand All @@ -241,7 +241,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### control\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L391-L411" signature="control_channel(qubits)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit

This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
Expand All @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### defaults

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L211-L225" signature="defaults(refresh=False)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend

**Parameters**
Expand All @@ -282,7 +282,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### drive\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L346-L359" signature="drive_channel(qubit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.
Expand All @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### measure\_channel

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L361-L374" signature="measure_channel(qubit)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.
Expand All @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### properties

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L197-L209" signature="properties(refresh=False)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties

**Parameters**
Expand Down Expand Up @@ -365,7 +365,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### refresh

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L562-L643" signature="refresh(service)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L643" signature="refresh(service)">
Update the data files from its real counterpart

This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
Expand All @@ -390,7 +390,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### run

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L413-L474" signature="run(run_input, **options)">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.

This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object.
Expand Down Expand Up @@ -435,7 +435,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### status

<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.

**Returns**
Expand Down
Loading

0 comments on commit 5aaf222

Please sign in to comment.