Skip to content
Open
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
14 changes: 10 additions & 4 deletions docs/api/qiskit-ibm-runtime/dev/batch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ python_api_name: qiskit_ibm_runtime.Batch

### from\_id

<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L324-L386" signature="from_id(session_id, service)" modifiers="classmethod">
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L324-L400" signature="from_id(session_id, service, use_fractional_gates=False, calibration_id=None)" modifiers="classmethod">
Construct a Session object with a given `session_id`. For example:

```python
Expand All @@ -179,11 +179,17 @@ python_api_name: qiskit_ibm_runtime.Batch

**Parameters**

* **session\_id** (*str*) – the id of the session to be created. This must be an already existing session id.
* **session\_id** (*str*) – The id of the session to be created. This must be an already existing session id.

* **service** ([*QiskitRuntimeService*](qiskit-runtime-service "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
* **service** ([*QiskitRuntimeService*](qiskit-runtime-service "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Instance of the `QiskitRuntimeService` class.

instance of the `QiskitRuntimeService` class.
* **use\_fractional\_gates** (*bool*) – Whether or not to allow fractional gates for the backend that is used to create the session.

* **calibration\_id** (*str | None*) –

**The calibration id for the backend that is used to create the**

session.

**Raises:**

Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit-ibm-runtime/dev/estimator-v2.mdx
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#L42-L172" 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#L41-L171" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
Bases: `BasePrimitiveV2`\[[`EstimatorOptions`](options-estimator-options "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions")], `Estimator`, [`BaseEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2)

Class for interacting with Qiskit Runtime Estimator primitive service.
Expand Down Expand Up @@ -93,7 +93,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2

### backend

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

**Return type**
Expand All @@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2

### run

<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L125-L148" signature="run(pubs, *, precision=None)">
<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L124-L147" signature="run(pubs, *, precision=None)">
Submit a request to the estimator primitive.

**Parameters**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/dev/estimator.mdx
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#L42-L172">
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L41-L171">
alias of [`EstimatorV2`](estimator-v2 "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.execution_span.ExecutionSpans

# ExecutionSpans

<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L27-L145" signature="ExecutionSpans(spans)" modifiers="class">
<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L27-L144" signature="ExecutionSpans(spans)" modifiers="class">
Bases: `object`

A collection of timings for pub results.
Expand Down Expand Up @@ -63,7 +63,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans

### draw

<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.draw" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L121-L145" signature="draw(name=None, normalize_y=False, line_width=4)">
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.draw" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L121-L144" signature="draw(name=None, normalize_y=False, line_width=4)">
Draw these execution spans.

<Admonition title="Note" type="note">
Expand Down
20 changes: 10 additions & 10 deletions docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-algiers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### backend\_name

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.backend_name" attributeValue="'fake_algiers'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.backend_name" attributeTypeHint="str | None" attributeValue="'fake_algiers'" />

### conf\_filename

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.conf_filename" attributeValue="'conf_algiers.json'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.conf_filename" attributeTypeHint="str | None" attributeValue="'conf_algiers.json'" />

### coupling\_map

Expand All @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### dirname

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/algiers'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.dirname" attributeTypeHint="str | None" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/algiers'" />

### dt

Expand Down Expand Up @@ -119,7 +119,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers

### props\_filename

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.props_filename" attributeValue="'props_algiers.json'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.props_filename" attributeTypeHint="str | None" attributeValue="'props_algiers.json'" />

### provider

Expand Down Expand Up @@ -177,7 +177,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#L175-L207" 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#L172-L204" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.

**Parameters**
Expand All @@ -195,7 +195,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#L171-L173" 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#L168-L170" signature="configuration()">
Return the backend configuration.

**Return type**
Expand All @@ -205,7 +205,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#L158-L169" 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#L155-L166" signature="properties(refresh=False)">
Return the backend properties

**Parameters**
Expand Down Expand Up @@ -247,7 +247,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#L391-L462" signature="refresh(service, use_fractional_gates=False)">
<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#L388-L459" signature="refresh(service, use_fractional_gates=False)">
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:
Expand Down Expand Up @@ -275,7 +275,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#L277-L306" 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#L274-L303" 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) using BasicSimulator or Aer simulator and returns a [`Job`](/docs/api/qiskit/qiskit.providers.Job) object.
Expand Down Expand Up @@ -316,7 +316,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#L140-L156" 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#L137-L153" signature="status()">
Return the backend status.

**Returns**
Expand Down
20 changes: 10 additions & 10 deletions docs/api/qiskit-ibm-runtime/dev/fake-provider-fake-almaden-v2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### backend\_name

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.backend_name" attributeValue="'fake_almaden'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.backend_name" attributeTypeHint="str | None" attributeValue="'fake_almaden'" />

### conf\_filename

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.conf_filename" attributeValue="'conf_almaden.json'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.conf_filename" attributeTypeHint="str | None" attributeValue="'conf_almaden.json'" />

### coupling\_map

Expand All @@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### dirname

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/almaden'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.dirname" attributeTypeHint="str | None" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/almaden'" />

### dt

Expand Down Expand Up @@ -129,7 +129,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2

### props\_filename

<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.props_filename" attributeValue="'props_almaden.json'" />
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.props_filename" attributeTypeHint="str | None" attributeValue="'props_almaden.json'" />

### provider

Expand Down Expand Up @@ -187,7 +187,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#L175-L207" 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#L172-L204" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.

**Parameters**
Expand All @@ -205,7 +205,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#L171-L173" 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#L168-L170" signature="configuration()">
Return the backend configuration.

**Return type**
Expand All @@ -215,7 +215,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#L158-L169" 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#L155-L166" signature="properties(refresh=False)">
Return the backend properties

**Parameters**
Expand Down Expand Up @@ -257,7 +257,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#L391-L462" signature="refresh(service, use_fractional_gates=False)">
<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#L388-L459" signature="refresh(service, use_fractional_gates=False)">
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:
Expand Down Expand Up @@ -285,7 +285,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#L277-L306" 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#L274-L303" 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) using BasicSimulator or Aer simulator and returns a [`Job`](/docs/api/qiskit/qiskit.providers.Job) object.
Expand Down Expand Up @@ -326,7 +326,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#L140-L156" 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#L137-L153" signature="status()">
Return the backend status.

**Returns**
Expand Down
Loading
Loading