Skip to content

Commit

Permalink
Generate again
Browse files Browse the repository at this point in the history
  • Loading branch information
@Eric-Arellano
Eric-Arellano committed Nov 19, 2024
1 parent 3b6a92f commit 86d3d78
Show file tree
Hide file tree
Showing 108 changed files with 2,304 additions and 4,392 deletions.
36 changes: 18 additions & 18 deletions docs/api/qiskit-ibm-runtime/options.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,25 @@ Refer to [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ib

### Base primitive options

| | |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\*args, \*\*kwargs) | Options for V2 Estimator. |
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\*args, \*\*kwargs) | Options for V2 Sampler. |
| | |
| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\[\_VERSION, ...]) | Options for V2 Estimator. |
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\[\_VERSION, ...]) | Options for V2 Sampler. |

### Suboptions

| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions")(\*args, \*\*kwargs) | Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). |
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). |
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. |
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. |
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. |
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. |
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. |
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. |
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. |
| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2")(\*args, \*\*kwargs) | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. |
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. |
| | |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions")(\[\_VERSION, ...]) | Options for `NoiseLearner`. |
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\[enable, ...]) | Options for dynamical decoupling (DD). |
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\[measure\_mitigation, ...]) | Resilience options for V2 Estimator. |
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\[...]) | Options for learning layer noise. |
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\[...]) | Options for measurement noise learning. |
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\[max\_overhead, noise\_gain]) | Probabalistic error cancellation mitigation options. |
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\[amplifier, noise\_factors, ...]) | Zero noise extrapolation mitigation options. |
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\[enable\_gates, ...]) | Twirling options. |
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\[init\_qubits, rep\_delay]) | Execution options for V2 primitives. |
| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2")(\[init\_qubits, ...]) | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\[log\_level, callback, ...]) | Options related to the execution environment. |
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\[noise\_model, ...]) | Simulator options. |

56 changes: 24 additions & 32 deletions docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ python_api_name: qiskit_ibm_runtime.Batch

**Parameters**

* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) 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`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated.
* **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](/guides/max-execution-time).
* **service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService") *| None*) – (DEPRECATED) 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** (*str |* [*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") *| None*) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated.
* **max\_time** (*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](/guides/max-execution-time).

**Raises**

Expand All @@ -83,10 +83,6 @@ python_api_name: qiskit_ibm_runtime.Batch
<Attribute id="qiskit_ibm_runtime.Batch.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.
Expand All @@ -97,10 +93,6 @@ python_api_name: qiskit_ibm_runtime.Batch
<Attribute id="qiskit_ibm_runtime.Batch.session_id">
Return the session ID.

**Return type**

`Optional`\[`str`]

**Returns**

Session ID. None if the backend is a simulator.
Expand All @@ -113,13 +105,13 @@ python_api_name: qiskit_ibm_runtime.Batch
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.33/qiskit_ibm_runtime/session.py#L240-L248" signature="backend()">
Return backend for this session.

**Return type**

`Optional`\[`str`]

**Returns**

Backend for this session. None if unknown.

**Return type**

str | None
</Function>

### cancel
Expand All @@ -129,7 +121,7 @@ python_api_name: qiskit_ibm_runtime.Batch

**Return type**

`None`
None
</Function>

### close
Expand All @@ -139,18 +131,14 @@ python_api_name: qiskit_ibm_runtime.Batch

**Return type**

`None`
None
</Function>

### details

<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.33/qiskit_ibm_runtime/session.py#L291-L333" signature="details()">
Return session details.

**Return type**

`Optional`\[`Dict`\[`str`, `Any`]]

**Returns**

A dictionary with the sessions details.
Expand All @@ -169,6 +157,10 @@ python_api_name: qiskit_ibm_runtime.Batch
* `activated_at`: Timestamp of when the session state was changed to active.
* `mode`: Execution mode of the session.
* `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job.

**Return type**

*Dict*\[str, *Any*] | None
</Function>

### from\_id
Expand All @@ -178,34 +170,30 @@ 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_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
* **service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –

instance of the `QiskitRuntimeService` class.

**Raises:**

IBMInputValueError: If given session\_id does not exist.

**Return type**

[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")

**Returns**

A new Session with the given `session_id`

**Return type**

[*Session*](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
</Function>

### status

<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.33/qiskit_ibm_runtime/session.py#L250-L275" signature="status()">
Return current session status.

**Return type**

`Optional`\[`str`]

**Returns**

Session status as a string.
Expand All @@ -215,6 +203,10 @@ python_api_name: qiskit_ibm_runtime.Batch
* `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**

str | None
</Function>

### usage
Expand All @@ -228,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.Batch

**Return type**

`Optional`\[`float`]
float | None
</Function>
</Class>

Loading

0 comments on commit 86d3d78

Please sign in to comment.