Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API dev docs #2211

Closed
wants to merge 1 commit into from
Closed
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
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 @@ -90,6 +90,10 @@
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/dev/execution_span"
},
{
"title": "DoubleSliceSpan",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.DoubleSliceSpan"
},
{
"title": "ExecutionSpan",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpan"
Expand Down Expand Up @@ -501,6 +505,10 @@
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/dev/visualization"
},
{
"title": "draw_execution_spans",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans"
},
{
"title": "draw_layer_error_map",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map"
Expand Down
13 changes: 7 additions & 6 deletions docs/api/qiskit-ibm-runtime/dev/execution_span.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_i

## Classes

| | |
| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")(start, stop) | Abstract parent for classes that store an execution time span for a subset of job data. |
| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")(spans) | A collection of timings for pub results. |
| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType") | alias of `Tuple`\[`int`, ...] |
| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`DoubleSliceSpan`](qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")(start, stop) | Abstract parent for classes that store an execution time span for a subset of job data. |
| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")(spans) | A collection of timings for pub results. |
| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType") | alias of `Tuple`\[`int`, ...] |
| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator

# Estimator

<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L190">
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L181">
alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2")
</Attribute>

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2

# EstimatorV2

<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L190" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L181" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
Class for interacting with Qiskit Runtime Estimator primitive service.

Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
Expand Down Expand Up @@ -97,6 +97,16 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2

## Methods

### backend

<Function id="qiskit_ibm_runtime.EstimatorV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L237-L239" signature="backend()">
Return the backend the primitive query will be run on.

**Return type**

BackendV1 | BackendV2
</Function>

### run

<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L134-L157" signature="run(pubs, *, precision=None)">
Expand Down
44 changes: 27 additions & 17 deletions docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx
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#L74-L923" 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-L937" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
Backend class interfacing with an IBM Quantum backend.

<Admonition title="Note" type="note">
Expand Down Expand Up @@ -343,7 +343,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### \_\_call\_\_

<Function id="qiskit_ibm_runtime.IBMBackend.__call__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L527-L529" signature="__call__()">
<Function id="qiskit_ibm_runtime.IBMBackend.__call__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L541-L543" signature="__call__()">
Call self as a function.

**Return type**
Expand All @@ -353,7 +353,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### acquire\_channel

<Function id="qiskit_ibm_runtime.IBMBackend.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L501-L507" signature="acquire_channel(qubit)">
<Function id="qiskit_ibm_runtime.IBMBackend.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L515-L521" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.

**Returns**
Expand All @@ -367,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### cancel\_session

<Function id="qiskit_ibm_runtime.IBMBackend.cancel_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L888-L902" signature="cancel_session()">
<Function id="qiskit_ibm_runtime.IBMBackend.cancel_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L902-L916" signature="cancel_session()">
Cancel session. All pending jobs will be cancelled.

**Return type**
Expand All @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### check\_faulty

<Function id="qiskit_ibm_runtime.IBMBackend.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L551-L583" signature="check_faulty(circuit)">
<Function id="qiskit_ibm_runtime.IBMBackend.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L565-L597" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.

**Parameters**
Expand All @@ -395,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### close\_session

<Function id="qiskit_ibm_runtime.IBMBackend.close_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L904-L919" signature="close_session()">
<Function id="qiskit_ibm_runtime.IBMBackend.close_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L918-L933" signature="close_session()">
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.

**Return type**
Expand All @@ -405,7 +405,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### configuration

<Function id="qiskit_ibm_runtime.IBMBackend.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L459-L483" signature="configuration()">
<Function id="qiskit_ibm_runtime.IBMBackend.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L473-L497" signature="configuration()">
Return the backend configuration.

Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc.
Expand Down Expand Up @@ -435,7 +435,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### control\_channel

<Function id="qiskit_ibm_runtime.IBMBackend.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L509-L522" signature="control_channel(qubits)">
<Function id="qiskit_ibm_runtime.IBMBackend.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L523-L536" 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 @@ -455,7 +455,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### defaults

<Function id="qiskit_ibm_runtime.IBMBackend.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L436-L457" signature="defaults(refresh=False)">
<Function id="qiskit_ibm_runtime.IBMBackend.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L450-L471" signature="defaults(refresh=False)">
Return the pulse defaults for the backend.

The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas/default\_pulse\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json).
Expand All @@ -475,7 +475,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### drive\_channel

<Function id="qiskit_ibm_runtime.IBMBackend.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L485-L491" signature="drive_channel(qubit)">
<Function id="qiskit_ibm_runtime.IBMBackend.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L499-L505" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.

**Returns**
Expand All @@ -489,7 +489,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#L921-L923" 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#L935-L937" signature="get_translation_stage_plugin()">
Return the default translation stage plugin name for IBM backends.

**Return type**
Expand All @@ -499,7 +499,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### measure\_channel

<Function id="qiskit_ibm_runtime.IBMBackend.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L493-L499" signature="measure_channel(qubit)">
<Function id="qiskit_ibm_runtime.IBMBackend.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L507-L513" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.

**Returns**
Expand All @@ -513,7 +513,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### open\_session

<Function id="qiskit_ibm_runtime.IBMBackend.open_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L858-L874" signature="open_session(max_time=None)">
<Function id="qiskit_ibm_runtime.IBMBackend.open_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L872-L888" signature="open_session(max_time=None)">
Open session

**Return type**
Expand All @@ -523,7 +523,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### properties

<Function id="qiskit_ibm_runtime.IBMBackend.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L360-L410" signature="properties(refresh=False, datetime=None)">
<Function id="qiskit_ibm_runtime.IBMBackend.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L374-L424" signature="properties(refresh=False, datetime=None)">
Return the backend properties, subject to optional filtering.

This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend.
Expand Down Expand Up @@ -573,9 +573,19 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>

### refresh

<Function id="qiskit_ibm_runtime.IBMBackend.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L363-L372" signature="refresh()">
Retrieve the newest backend configuration and refresh the current backend target.

**Return type**

`None`
</Function>

### run

<Function id="qiskit_ibm_runtime.IBMBackend.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L603-L774" signature="run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)">
<Function id="qiskit_ibm_runtime.IBMBackend.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L617-L788" signature="run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)">
Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run.

**Parameters**
Expand Down Expand Up @@ -664,7 +674,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### status

<Function id="qiskit_ibm_runtime.IBMBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L412-L434" signature="status()">
<Function id="qiskit_ibm_runtime.IBMBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L426-L448" signature="status()">
Return the backend status.

<Admonition title="Note" type="note">
Expand All @@ -686,7 +696,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend

### target\_history

<Function id="qiskit_ibm_runtime.IBMBackend.target_history" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L349-L358" signature="target_history(datetime=None)">
<Function id="qiskit_ibm_runtime.IBMBackend.target_history" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L352-L361" signature="target_history(datetime=None)">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.

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

# RuntimeDecoder

<Class id="qiskit_ibm_runtime.RuntimeDecoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L368-L469" signature="RuntimeDecoder(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.RuntimeDecoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L382-L489" signature="RuntimeDecoder(*args, **kwargs)" modifiers="class">
JSON Decoder used by runtime service.

`object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting).
Expand All @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder

### object\_hook

<Function id="qiskit_ibm_runtime.RuntimeDecoder.object_hook" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L376-L469" signature="object_hook(obj)">
<Function id="qiskit_ibm_runtime.RuntimeDecoder.object_hook" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L390-L489" signature="object_hook(obj)">
Called to decode object.

**Return type**
Expand Down
Loading
Loading