80 lines
5.2 KiB
Plaintext
80 lines
5.2 KiB
Plaintext
---
|
|
title: quimb (latest version)
|
|
description: API reference for qiskit_addon_aqc_tensor.simulation.quimb in the latest version of qiskit-addon-aqc-tensor
|
|
in_page_toc_min_heading_level: 2
|
|
python_api_type: module
|
|
python_api_name: qiskit_addon_aqc_tensor.simulation.quimb
|
|
---
|
|
|
|
<span id="module-qiskit_addon_aqc_tensor.simulation.quimb" />
|
|
|
|
<span id="quimb-simulation-backend-qiskit-addon-aqc-tensor-simulation-quimb" />
|
|
|
|
# Quimb simulation backend
|
|
|
|
`qiskit_addon_aqc_tensor.simulation.quimb`
|
|
|
|
Quimb as a tensor network backend.
|
|
|
|
| | |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
| [`QuimbCircuitFactory`](simulation-quimb-quimb-circuit-factory "qiskit_addon_aqc_tensor.simulation.quimb.QuimbCircuitFactory") | Quimb circuit factory. |
|
|
| [`QuimbSimulator`](simulation-quimb-quimb-simulator "qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator") | Settings for Quimb simulator. |
|
|
| [`QiskitQuimbConversionContext`](simulation-quimb-qiskit-quimb-conversion-context "qiskit_addon_aqc_tensor.simulation.quimb.QiskitQuimbConversionContext") | Contains information about Qiskit-to-Quimb conversion, necessary to recover Qiskit parameters. |
|
|
|
|
## Functions
|
|
|
|
### is\_quimb\_available
|
|
|
|
<Function id="qiskit_addon_aqc_tensor.simulation.quimb.is_quimb_available" github="https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.1/qiskit_addon_aqc_tensor/simulation/quimb/__init__.py#L57-L63" signature="is_quimb_available()[source]">
|
|
Return `True` is qiskit-quimb is installed, `False` otherwise.
|
|
|
|
**Return type**
|
|
|
|
[`bool`](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")
|
|
</Function>
|
|
|
|
### qiskit\_ansatz\_to\_quimb
|
|
|
|
<Function id="qiskit_addon_aqc_tensor.simulation.quimb.qiskit_ansatz_to_quimb" github="https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.1/qiskit_addon_aqc_tensor/simulation/quimb/__init__.py#L188-L268" signature="qiskit_ansatz_to_quimb(qc, initial_parameters, /)[source]">
|
|
Convert a Qiskit ansatz to a Quimb parametrized circuit.
|
|
|
|
**Return type**
|
|
|
|
[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[`Circuit`](https://quimb.readthedocs.io/en/latest/autoapi/quimb/tensor/circuit/index.html#quimb.tensor.circuit.Circuit "(in quimb v1.9)"), [`QiskitQuimbConversionContext`](simulation-quimb-qiskit-quimb-conversion-context "qiskit_addon_aqc_tensor.simulation.quimb.QiskitQuimbConversionContext")]
|
|
|
|
**Parameters**
|
|
|
|
* **qc** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"))
|
|
* **initial\_parameters** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*)
|
|
</Function>
|
|
|
|
### recover\_parameters\_from\_quimb
|
|
|
|
<Function id="qiskit_addon_aqc_tensor.simulation.quimb.recover_parameters_from_quimb" github="https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.1/qiskit_addon_aqc_tensor/simulation/quimb/__init__.py#L271-L285" signature="recover_parameters_from_quimb(circ_opt, ctx, /)[source]">
|
|
Recover Qiskit circuit parameters from a Quimb circuit.
|
|
|
|
**Parameters**
|
|
|
|
* **circ\_opt** ([*Circuit*](https://quimb.readthedocs.io/en/latest/autoapi/quimb/tensor/circuit/index.html#quimb.tensor.circuit.Circuit "(in quimb v1.9)"))
|
|
* **ctx** ([*QiskitQuimbConversionContext*](simulation-quimb-qiskit-quimb-conversion-context "qiskit_addon_aqc_tensor.simulation.quimb.QiskitQuimbConversionContext"))
|
|
</Function>
|
|
|
|
### tnoptimizer\_objective\_kwargs
|
|
|
|
<Function id="qiskit_addon_aqc_tensor.simulation.quimb.tnoptimizer_objective_kwargs" github="https://github.com/Qiskit/qiskit-addon-aqc-tensor/tree/stable/0.1/qiskit_addon_aqc_tensor/simulation/quimb.py" signature="tnoptimizer_objective_kwargs(objective, /)">
|
|
Return keyword arguments for use with `TNOptimizer()`. :rtype: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [`Any`](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")]
|
|
|
|
* `loss_fn`
|
|
* `loss_kwargs`
|
|
|
|
**Parameters**
|
|
|
|
**objective** ([*OneMinusFidelity*](objective#qiskit_addon_aqc_tensor.objective.OneMinusFidelity "qiskit_addon_aqc_tensor.objective.OneMinusFidelity"))
|
|
|
|
**Return type**
|
|
|
|
[dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")]
|
|
</Function>
|
|
|