Skip to content
Merged
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
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/dev/qk-neighbors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ python_api_name: QkNeighbors

<span id="group__QkNeighbors_1autotoc_md372" />

`neighbors` must point to a valid, initialized `QkNeighbors` object.
`neighbors` must an aligned pointer to a valid, initialized `QkNeighbors` object.

**Parameters**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/dev/executor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.Executor

Refer to the [Qiskit Runtime documentation](/docs/guides/execution-modes) for more information about the `Execution modes`.

* **options** ([*ExecutorOptions*](options-models-executor-options "qiskit_ibm_runtime.options_models.executor_options.ExecutorOptions")) – Executor options, see `ExecutorOptions` for detailed description. This can be an `ExecutorOptions` instance or a dictionary that will be used to construct one.
* **options** ([*ExecutorOptions*](options-models-executor-options "qiskit_ibm_runtime.options_models.executor.ExecutorOptions")) – Executor options, see `ExecutorOptions` for detailed description. This can be an `ExecutorOptions` instance or a dictionary that will be used to construct one.

**Raises**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.BaseParamsModel

# BaseParamsModel

<Class id="ibm_quantum_schemas.common.BaseParamsModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/base_params.py#L18-L22" signature="BaseParamsModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.BaseParamsModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/base_params.py#L18-L22" signature="BaseParamsModel" modifiers="pydantic model">
Bases: `BaseModel`

Model of a runtime program’s inner parameters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.CompressedQpyDataModel

# CompressedQpyDataModel

<Class id="ibm_quantum_schemas.common.CompressedQpyDataModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qpy.py#L152-L239" signature="CompressedQpyDataModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.CompressedQpyDataModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qpy.py#L152-L239" signature="CompressedQpyDataModel" modifiers="pydantic model">
Bases: [`QpyDataModel`](ibm-quantum-schemas-common-qpy-data-model "ibm_quantum_schemas.common.qpy.QpyDataModel"), `Generic`\[`T`]

QPY-encoded Qiskit objects with compression.
Expand Down Expand Up @@ -55,13 +55,13 @@ python_api_name: ibm_quantum_schemas.common.CompressedQpyDataModel

### cross\_validate\_qpy\_info

<Function id="ibm_quantum_schemas.common.CompressedQpyDataModel.cross_validate_qpy_info" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qpy.py#L155-L169" signature="cross_validate_qpy_info" modifiers="validator">
<Function id="ibm_quantum_schemas.common.CompressedQpyDataModel.cross_validate_qpy_info" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qpy.py#L155-L169" signature="cross_validate_qpy_info" modifiers="validator">
Check that the encoded qpy information matches expectations.
</Function>

### from\_python

<Function id="ibm_quantum_schemas.common.CompressedQpyDataModel.from_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qpy.py#L201-L239" signature="from_python(data, qpy_version=17, metadata_serializer=None)" modifiers="classmethod">
<Function id="ibm_quantum_schemas.common.CompressedQpyDataModel.from_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qpy.py#L201-L239" signature="from_python(data, qpy_version=17, metadata_serializer=None)" modifiers="classmethod">
Create a model instance from Python data of the correct type.

The returned instance owns a reference to the provided data. This instance may be returned by [`to_python()`](#ibm_quantum_schemas.common.CompressedQpyDataModel.to_python "ibm_quantum_schemas.common.CompressedQpyDataModel.to_python") depending on the value of `use_cached`. Users of this class are responsible for managing cached instances of the data and possible side-effects of their mutations.
Expand All @@ -83,7 +83,7 @@ python_api_name: ibm_quantum_schemas.common.CompressedQpyDataModel

### to\_python

<Function id="ibm_quantum_schemas.common.CompressedQpyDataModel.to_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qpy.py#L171-L199" signature="to_python(use_cached=False, metadata_deserializer=None)">
<Function id="ibm_quantum_schemas.common.CompressedQpyDataModel.to_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qpy.py#L171-L199" signature="to_python(use_cached=False, metadata_deserializer=None)">
Return a Python representation of the encoded data in the model.

When `use_cached` is false, or when no cached version exists, [`b64_data`](#ibm_quantum_schemas.common.CompressedQpyDataModel.b64_data "ibm_quantum_schemas.common.CompressedQpyDataModel.b64_data") is decoded and loaded into a new Python instance. Users of this class are responsible for managing cached instances of the Python data and possible side-effects of their mutations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.CompressedTensorModel

# CompressedTensorModel

<Class id="ibm_quantum_schemas.common.CompressedTensorModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L134-L203" signature="CompressedTensorModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.CompressedTensorModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L134-L203" signature="CompressedTensorModel" modifiers="pydantic model">
Bases: [`TensorModel`](ibm-quantum-schemas-common-tensor-model "ibm_quantum_schemas.common.tensor.TensorModel")

Model of compressed tensor data.
Expand Down Expand Up @@ -49,13 +49,13 @@ python_api_name: ibm_quantum_schemas.common.CompressedTensorModel

### check\_sizes

<Function id="ibm_quantum_schemas.common.CompressedTensorModel.check_sizes" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L191-L203" signature="check_sizes" modifiers="validator">
<Function id="ibm_quantum_schemas.common.CompressedTensorModel.check_sizes" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L191-L203" signature="check_sizes" modifiers="validator">
Cross-validate that all sizes are consistent.
</Function>

### from\_numpy

<Function id="ibm_quantum_schemas.common.CompressedTensorModel.from_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L158-L173" signature="from_numpy(array)" modifiers="classmethod">
<Function id="ibm_quantum_schemas.common.CompressedTensorModel.from_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L158-L173" signature="from_numpy(array)" modifiers="classmethod">
Instantiate from a NumPy array.

**Parameters**
Expand All @@ -65,7 +65,7 @@ python_api_name: ibm_quantum_schemas.common.CompressedTensorModel

### to\_numpy

<Function id="ibm_quantum_schemas.common.CompressedTensorModel.to_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L175-L189" signature="to_numpy()">
<Function id="ibm_quantum_schemas.common.CompressedTensorModel.to_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L175-L189" signature="to_numpy()">
Convert to a NumPy Array.

**Return type**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.F64CompressedTensorModel

# F64CompressedTensorModel

<Class id="ibm_quantum_schemas.common.F64CompressedTensorModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L206-L209" signature="F64CompressedTensorModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.F64CompressedTensorModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L206-L209" signature="F64CompressedTensorModel" modifiers="pydantic model">
Bases: [`CompressedTensorModel`](ibm-quantum-schemas-common-compressed-tensor-model "ibm_quantum_schemas.common.tensor.CompressedTensorModel")

Model of compressed tensor data specialized to f64.
Expand Down Expand Up @@ -49,13 +49,13 @@ python_api_name: ibm_quantum_schemas.common.F64CompressedTensorModel

### check\_sizes

<Function id="ibm_quantum_schemas.common.F64CompressedTensorModel.check_sizes" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L191-L203" signature="check_sizes" modifiers="validator">
<Function id="ibm_quantum_schemas.common.F64CompressedTensorModel.check_sizes" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L191-L203" signature="check_sizes" modifiers="validator">
Cross-validate that all sizes are consistent.
</Function>

### from\_numpy

<Function id="ibm_quantum_schemas.common.F64CompressedTensorModel.from_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L158-L173" signature="from_numpy(array)" modifiers="classmethod">
<Function id="ibm_quantum_schemas.common.F64CompressedTensorModel.from_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L158-L173" signature="from_numpy(array)" modifiers="classmethod">
Instantiate from a NumPy array.

**Parameters**
Expand All @@ -65,7 +65,7 @@ python_api_name: ibm_quantum_schemas.common.F64CompressedTensorModel

### to\_numpy

<Function id="ibm_quantum_schemas.common.F64CompressedTensorModel.to_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L175-L189" signature="to_numpy()">
<Function id="ibm_quantum_schemas.common.F64CompressedTensorModel.to_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L175-L189" signature="to_numpy()">
Convert to a NumPy Array.

**Return type**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.F64TensorModel

# F64TensorModel

<Class id="ibm_quantum_schemas.common.F64TensorModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L128-L131" signature="F64TensorModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.F64TensorModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L128-L131" signature="F64TensorModel" modifiers="pydantic model">
Bases: [`TensorModel`](ibm-quantum-schemas-common-tensor-model "ibm_quantum_schemas.common.tensor.TensorModel")

Model of tensor data specialized to f64.
Expand Down Expand Up @@ -49,13 +49,13 @@ python_api_name: ibm_quantum_schemas.common.F64TensorModel

### check\_sizes

<Function id="ibm_quantum_schemas.common.F64TensorModel.check_sizes" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L111-L125" signature="check_sizes" modifiers="validator">
<Function id="ibm_quantum_schemas.common.F64TensorModel.check_sizes" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L111-L125" signature="check_sizes" modifiers="validator">
Cross-validate that all sizes are consistent.
</Function>

### from\_numpy

<Function id="ibm_quantum_schemas.common.F64TensorModel.from_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L68-L90" signature="from_numpy(array)" modifiers="classmethod">
<Function id="ibm_quantum_schemas.common.F64TensorModel.from_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L68-L90" signature="from_numpy(array)" modifiers="classmethod">
Instantiate from a NumPy array.

**Parameters**
Expand All @@ -65,7 +65,7 @@ python_api_name: ibm_quantum_schemas.common.F64TensorModel

### to\_numpy

<Function id="ibm_quantum_schemas.common.F64TensorModel.to_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/tensor.py#L92-L109" signature="to_numpy()">
<Function id="ibm_quantum_schemas.common.F64TensorModel.to_numpy" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/tensor.py#L92-L109" signature="to_numpy()">
Convert to a NumPy Array.

**Return type**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.OpenQasm3DataModel

# OpenQasm3DataModel

<Class id="ibm_quantum_schemas.common.OpenQasm3DataModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qasm.py#L30-L96" signature="OpenQasm3DataModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.OpenQasm3DataModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qasm.py#L30-L96" signature="OpenQasm3DataModel" modifiers="pydantic model">
Bases: `BaseModel`, `Generic`\[`T`]

OpenQASM3-encoded objects.
Expand All @@ -23,7 +23,7 @@ python_api_name: ibm_quantum_schemas.common.OpenQasm3DataModel

### from\_python

<Function id="ibm_quantum_schemas.common.OpenQasm3DataModel.from_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qasm.py#L75-L96" signature="from_python(data)" modifiers="classmethod">
<Function id="ibm_quantum_schemas.common.OpenQasm3DataModel.from_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qasm.py#L75-L96" signature="from_python(data)" modifiers="classmethod">
Create a model instance from Python data of the correct type.

The returned instance owns a reference to the provided data. This instance may be returned by [`to_python()`](#ibm_quantum_schemas.common.OpenQasm3DataModel.to_python "ibm_quantum_schemas.common.OpenQasm3DataModel.to_python") depending on the value of `use_cached`. Users of this class are responsible for managing cached instances of the data and possible side-effects of their mutations.
Expand All @@ -43,7 +43,7 @@ python_api_name: ibm_quantum_schemas.common.OpenQasm3DataModel

### to\_python

<Function id="ibm_quantum_schemas.common.OpenQasm3DataModel.to_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/qasm.py#L46-L73" signature="to_python(use_cached=False)">
<Function id="ibm_quantum_schemas.common.OpenQasm3DataModel.to_python" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/qasm.py#L46-L73" signature="to_python(use_cached=False)">
Return a Python representation of the encoded data in the model.

When `use_cached` is false, or when no cached version exists, [`data`](#ibm_quantum_schemas.common.OpenQasm3DataModel.data "ibm_quantum_schemas.common.OpenQasm3DataModel.data") is decoded and loaded into a new Python instance. Users of this class are responsible for managing cached instances of the Python data and possible side-effects of their mutations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: ibm_quantum_schemas.common.PauliLindbladMapModel

# PauliLindbladMapModel

<Class id="ibm_quantum_schemas.common.PauliLindbladMapModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/pauli_lindblad_map.py#L19-L40" signature="PauliLindbladMapModel" modifiers="pydantic model">
<Class id="ibm_quantum_schemas.common.PauliLindbladMapModel" isDedicatedPage={true} github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/pauli_lindblad_map.py#L19-L40" signature="PauliLindbladMapModel" modifiers="pydantic model">
Bases: `BaseModel`

Encoding of a sparse Pauli Lindblad map.
Expand All @@ -33,7 +33,7 @@ python_api_name: ibm_quantum_schemas.common.PauliLindbladMapModel

### from\_pauli\_lindblad\_map

<Function id="ibm_quantum_schemas.common.PauliLindbladMapModel.from_pauli_lindblad_map" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/pauli_lindblad_map.py#L28-L36" signature="from_pauli_lindblad_map(pauli_lindblad_map)" modifiers="classmethod">
<Function id="ibm_quantum_schemas.common.PauliLindbladMapModel.from_pauli_lindblad_map" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/pauli_lindblad_map.py#L28-L36" signature="from_pauli_lindblad_map(pauli_lindblad_map)" modifiers="classmethod">
Encode a [`qiskit.quantum_info.PauliLindbladMap`](/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap) into this model.

**Parameters**
Expand All @@ -47,7 +47,7 @@ python_api_name: ibm_quantum_schemas.common.PauliLindbladMapModel

### to\_pauli\_lindblad\_map

<Function id="ibm_quantum_schemas.common.PauliLindbladMapModel.to_pauli_lindblad_map" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc1/ibm_quantum_schemas/common/pauli_lindblad_map.py#L38-L40" signature="to_pauli_lindblad_map()">
<Function id="ibm_quantum_schemas.common.PauliLindbladMapModel.to_pauli_lindblad_map" github="https://github.com/Qiskit/ibm-quantum-schemas/tree/0.10rc2/ibm_quantum_schemas/common/pauli_lindblad_map.py#L38-L40" signature="to_pauli_lindblad_map()">
Decode this model into a [`qiskit.quantum_info.PauliLindbladMap`](/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap).

**Return type**
Expand Down
Loading
Loading