diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json
index 95e411db6a8..43b51dd9f22 100644
--- a/docs/api/qiskit-ibm-runtime/dev/_toc.json
+++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json
@@ -8,6 +8,10 @@
"title": "Overview",
"url": "/api/qiskit-ibm-runtime/dev/runtime_service"
},
+ {
+ "title": "Batch",
+ "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch"
+ },
{
"title": "EstimatorV1",
"url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1"
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx
new file mode 100644
index 00000000000..a7effe81bfe
--- /dev/null
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx
@@ -0,0 +1,199 @@
+---
+title: Batch
+description: API reference for qiskit_ibm_runtime.Batch
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_runtime.Batch
+---
+
+# Batch
+
+
+ Class for running jobs in batch execution mode.
+
+ Similar to a `session`, a Qiskit Runtime `batch` groups a collection of iterative calls to the quantum computer. Batch mode can shorten processing time if all jobs can be provided at the outset. To submit iterative jobs, use sessions instead.
+
+ **Using batch mode has these benefits:**
+
+ * The jobs’ classical computation, such as compilation, is run in parallel. Thus, running multiple jobs in a batch is significantly faster than running them serially.
+ * There is minimal delay between job, which can help avoid drift.
+
+ You can open a Qiskit Runtime batch by using this `Batch` class, then submit jobs to one or more primitives.
+
+ For example:
+
+ ```python
+ from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister
+ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
+ from qiskit_ibm_runtime import Batch, SamplerV2 as Sampler
+
+ service = QiskitRuntimeService()
+ backend = service.least_busy(operational=True, simulator=False)
+
+ # Bell Circuit
+ qr = QuantumRegister(2, name="qr")
+ cr = ClassicalRegister(2, name="cr")
+ qc = QuantumCircuit(qr, cr, name="bell")
+ qc.h(qr[0])
+ qc.cx(qr[0], qr[1])
+ qc.measure(qr, cr)
+
+ pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
+ isa_circuit = pm.run(qc)
+
+ with Batch(backend=backend) as batch:
+ sampler = Sampler(batch)
+ job = sampler.run([isa_circuit])
+ pub_result = job.result()[0]
+ print(f"Sampler job ID: {job.job_id()}")
+ print(f"Counts: {pub_result.data.cr.get_counts()}")
+ ```
+
+ Batch constructor.
+
+ **Parameters**
+
+ * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account.
+ * **backend** (`Union`\[`str`, `BackendV1`, `BackendV2`, `None`]) – Optional instance of `Backend` class or backend string name.
+ * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time).
+
+ **Raises**
+
+ **ValueError** – If an input value is invalid.
+
+ ## Attributes
+
+ ### service
+
+
+ Return service associated with this session.
+
+ **Return type**
+
+ [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")
+
+ **Returns**
+
+ [`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") associated with this session.
+
+
+ ### session\_id
+
+
+ Return the session ID.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ Session ID. None if the backend is a simulator.
+
+
+ ## Methods
+
+ ### backend
+
+
+ Return backend for this session.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ Backend for this session. None if unknown.
+
+
+ ### cancel
+
+
+ Cancel all pending jobs in a session.
+
+ **Return type**
+
+ `None`
+
+
+ ### close
+
+
+ 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**
+
+ `None`
+
+
+ ### details
+
+
+ Return session details.
+
+ **Returns**
+
+ id: id of the session. backend\_name: backend used for the session. interactive\_timeout: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. max\_time: Maximum allowed time (in seconds) for the session, subject to plan limits. active\_timeout: The maximum time (in seconds) a session can stay active. state: State of the session - open, active, inactive, or closed. accepting\_jobs: Whether or not the session is accepting jobs. last\_job\_started: Timestamp of when the last job in the session started. last\_job\_completed: Timestamp of when the last job in the session completed. started\_at: Timestamp of when the session was started. closed\_at: Timestamp of when the session was closed. activated\_at: Timestamp of when the session state was changed to active.
+
+ **Return type**
+
+ A dictionary with the sessions details, including
+
+
+ ### from\_id
+
+
+ Construct a Session object with a given session\_id
+
+ **Parameters**
+
+ * **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id.
+ * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – instance of the `QiskitRuntimeService` class.
+ * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend.
+
+ **Return type**
+
+ [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
+
+ **Returns**
+
+ A new Session with the given `session_id`
+
+
+ ### run
+
+
+ Run a program in the session.
+
+ **Parameters**
+
+ * **program\_id** (`str`) – Program ID.
+ * **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program.
+ * **options** (`Optional`\[`Dict`]) – Runtime options that control the execution environment. See [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") for all available options.
+ * **callback** (`Optional`\[`Callable`]) – Callback function to be invoked for any interim results and final result.
+
+ **Return type**
+
+ `Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
+
+ **Returns**
+
+ Submitted job.
+
+
+ ### status
+
+
+ Return current session status.
+
+ **Returns**
+
+ Pending: Session is created but not active. It will become active when the next job of this session is dequeued. In progress, accepting new jobs: session is active and accepting new jobs. In progress, not accepting new jobs: session is active and not accepting new jobs. Closed: max\_time expired or session was explicitly closed. None: status details are not available.
+
+ **Return type**
+
+ The current status of the session, including
+
+
+
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx
index 1fde116f913..79d8d4dcbab 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator
# Estimator
-
+
alias of [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1")
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx
index 29575eaaa04..6bf70ae5c14 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1
# EstimatorV1
-
+
Class for interacting with Qiskit Runtime Estimator primitive service.
Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
@@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1
### run
-
+
Submit a request to the estimator primitive.
**Parameters**
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx
index bd545411ac8..29534eb0817 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
# EstimatorV2
-
+
Class for interacting with Qiskit Runtime Estimator primitive service.
Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
@@ -101,7 +101,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
### run
-
+
Submit a request to the estimator primitive.
**Parameters**
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx
index d0f2e019db1..f159bfa1ec6 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
# RuntimeDecoder
-
+
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).
@@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
### object\_hook
-
+
Called to decode object.
**Return type**
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx
index 5bb42068a9c..1d534a807bb 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
# RuntimeEncoder
-
+
JSON Encoder used by runtime service.
Constructor for JSONEncoder, with sensible defaults.
@@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
### default
-
+
Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`).
For example, to support arbitrary iterators, you could implement default like this:
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx
index b773ed1f0ae..7b7ae790099 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
# RuntimeJob
-
+
Representation of a runtime program execution.
A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job.
@@ -50,6 +50,14 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
## Attributes
+ ### ERROR
+
+
+
+ ### JOB\_FINAL\_STATES
+
+
+
### creation\_date
@@ -156,7 +164,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### backend
-
+
Return the backend where this job was executed. Retrieve data again if backend is None.
**Raises**
@@ -170,7 +178,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### cancel
-
+
Cancel the job.
**Raises**
@@ -185,7 +193,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### cancel\_result\_streaming
-
+
Cancel result streaming.
**Return type**
@@ -215,7 +223,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### error\_message
-
+
Returns the reason if the job failed.
**Return type**
@@ -229,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### errored
-
+
Return whether the job has failed.
**Return type**
@@ -239,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### in\_final\_state
-
+
Return whether the job is in a final job state such as `DONE` or `ERROR`.
**Return type**
@@ -249,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### interim\_results
-
+
Return the interim results of the job.
**Parameters**
@@ -281,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### logs
-
+
Return job logs.
@@ -303,7 +311,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### metrics
-
+
Return job metrics.
**Return type**
@@ -321,7 +329,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### properties
-
+
Return the backend properties for this job.
**Parameters**
@@ -339,7 +347,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### queue\_info
-
+
Return queue information for this job.
The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See `QueueInfo` for more information.
@@ -359,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### queue\_position
-
+
Return the position of the job in the server queue.
@@ -381,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### result
-
+
Return the results of the job.
**Parameters**
@@ -416,7 +424,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### status
-
+
Return the status of the job.
**Return type**
@@ -430,7 +438,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### stream\_results
-
+
Start streaming job results.
**Parameters**
@@ -455,7 +463,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### submit
-
+
Unsupported method. .. note:
```python
@@ -475,7 +483,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### update\_tags
-
+
Update the tags associated with this job.
**Parameters**
@@ -497,7 +505,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
### wait\_for\_final\_state
-
+
Use the websocket server to wait for the final the state of a job.
The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx
index e739c2bed84..f5f92719d3c 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
# RuntimeJobV2
-
+
Representation of a runtime V2 primitive exeuction.
RuntimeJob constructor.
@@ -32,6 +32,14 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
## Attributes
+ ### ERROR
+
+
+
+ ### JOB\_FINAL\_STATES
+
+
+
### creation\_date
@@ -134,7 +142,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### backend
-
+
Return the backend where this job was executed. Retrieve data again if backend is None.
**Raises**
@@ -148,7 +156,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### cancel
-
+
Cancel the job.
**Raises**
@@ -163,7 +171,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### cancel\_result\_streaming
-
+
Cancel result streaming.
**Return type**
@@ -173,7 +181,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### cancelled
-
+
Return whether the job has been cancelled.
**Return type**
@@ -183,7 +191,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### done
-
+
Return whether the job has successfully run.
**Return type**
@@ -193,7 +201,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### error\_message
-
+
Returns the reason if the job failed.
**Return type**
@@ -207,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### errored
-
+
Return whether the job has failed.
**Return type**
@@ -217,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### in\_final\_state
-
+
Return whether the job is in a final job state such as `DONE` or `ERROR`.
**Return type**
@@ -227,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### interim\_results
-
+
Return the interim results of the job.
**Parameters**
@@ -259,7 +267,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### logs
-
+
Return job logs.
@@ -281,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### metrics
-
+
Return job metrics.
**Return type**
@@ -299,7 +307,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### properties
-
+
Return the backend properties for this job.
**Parameters**
@@ -317,7 +325,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### result
-
+
Return the results of the job.
**Parameters**
@@ -342,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### running
-
+
Return whether the job is actively running.
**Return type**
@@ -352,7 +360,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### status
-
+
Return the status of the job.
**Return type**
@@ -366,7 +374,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### stream\_results
-
+
Start streaming job results.
**Parameters**
@@ -391,7 +399,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### update\_tags
-
+
Update the tags associated with this job.
**Parameters**
@@ -413,7 +421,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
### wait\_for\_final\_state
-
+
Use the websocket server to wait for the final the state of a job.
The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx
index 826672c1472..5af4fa37aa1 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler
# Sampler
-
+
alias of [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1")
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx
index dcd737d7ab5..2596998b8b2 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1
# SamplerV1
-
+
Class for interacting with Qiskit Runtime Sampler primitive service.
Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits.
@@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1
### run
-
+
Submit a request to the sampler primitive.
**Parameters**
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx
index f13bcd957ad..6700b696ab0 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
# SamplerV2
-
+
Class for interacting with Qiskit Runtime Sampler primitive service.
This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1.
@@ -69,7 +69,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
### run
-
+
Submit a request to the sampler primitive.
**Parameters**
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx
index ea41c99cef3..232c0e4471b 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx
index c6c2f840617..9bac3f129a5 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx
@@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx
index e8f88a797a8..7f1eb1c7252 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx
@@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -257,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -273,7 +273,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -313,12 +313,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx
index 6fc92c231fe..5592fb64ff2 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx
@@ -122,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx
index 11b65e6628c..7da532d08a1 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx
@@ -213,7 +213,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -229,7 +229,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -267,7 +267,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -307,12 +307,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx
index 0a3b5676082..0986d787ece 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx
@@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx
index a81cba1f7d8..5ff5e1fcf83 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx
index 8baa464c9e0..19c08d8ce33 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx
index ef46532ab08..2f8c7a7d494 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx
@@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx
index 75068b29d2e..e8085b457e6 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx
index 0bdee659da1..0778d44616e 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx
@@ -128,7 +128,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx
index a13c336fe68..f805e51ce3c 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx
@@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -257,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -273,7 +273,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -313,12 +313,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx
index 9ced0d13ca8..e934c77eb98 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx
@@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx
index db565800e2b..a865a455035 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx
index f23c3351f66..c17a7ae53a2 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx
index 4314c23a740..7de02a7cb80 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx
@@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx
index 4fcb3c713b6..1c4eb1ace8f 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx
index 470eed55251..cffc6b81646 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx
@@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx
index f2f76b6acd5..36db184b691 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx
@@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -269,7 +269,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -309,12 +309,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx
index 764598d3590..47055c99234 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx
@@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx
index f2972c12db0..83f726906d5 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -303,12 +303,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx
index e7e2d4a65ab..cd41f4d6146 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx
@@ -116,7 +116,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx
index 4c91837f38b..2fc36626928 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx
@@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -315,12 +315,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
### run
-
+
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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object.
+ 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` object.
- If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise.
+ If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx
index 1084538f29e..786a894232c 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx
@@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca
### run
-
+
Main job in simulator
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx
index 9d96def6983..2a091e82b27 100644
--- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx
+++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx
@@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
### control\_channel
-
+
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
### drive\_channel
-
+
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
@@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
### measure\_channel
-