Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regenerate Addons to remove broken links #2181

Merged
merged 1 commit into from
Oct 25, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ python_api_name: qiskit_addon_cutting.DeviceConstraints
# qiskit\_addon\_cutting.DeviceConstraints

<Class id="qiskit_addon_cutting.DeviceConstraints" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/automated_cut_finding.py" signature="DeviceConstraints(qubits_per_subcircuit)" modifiers="class">
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")

Specify the constraints (qubits per subcircuit) that must be respected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ python_api_name: qiskit_addon_cutting.OptimizationParameters
# qiskit\_addon\_cutting.OptimizationParameters

<Class id="qiskit_addon_cutting.OptimizationParameters" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/automated_cut_finding.py" signature="OptimizationParameters(seed=None, max_gamma=1024, max_backjumps=10000, gate_lo=True, wire_lo=True)" modifiers="class">
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")

Specify parameters that control the optimization.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ python_api_name: qiskit_addon_cutting.PartitionedCuttingProblem
# qiskit\_addon\_cutting.PartitionedCuttingProblem

<Class id="qiskit_addon_cutting.PartitionedCuttingProblem" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/cutting_decomposition.py" signature="PartitionedCuttingProblem(subcircuits: dict[Hashable, QuantumCircuit], bases: list[QPDBasis], subobservables: dict[Hashable, PauliList] | None = None)" modifiers="class">
Bases: [`NamedTuple`](https://docs.python.org/3/library/typing.html#typing.NamedTuple "(in Python v3.12)")
Bases: [`NamedTuple`](https://docs.python.org/3/library/typing.html#typing.NamedTuple "(in Python v3.13)")

The result of decomposing and separating a circuit and observable(s).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ python_api_name: qiskit_addon_cutting.cut_gates
**Parameters**

* **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – The circuit containing gates to be decomposed
* **gate\_ids** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")]) – The indices of the gates to decompose
* **inplace** ([`bool`](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Flag denoting whether to copy the input circuit before acting on it
* **gate\_ids** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]) – The indices of the gates to decompose
* **inplace** ([`bool`](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Flag denoting whether to copy the input circuit before acting on it

**Return type**

[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[`QPDBasis`](qiskit_addon_cutting.qpd.QPDBasis "qiskit_addon_cutting.qpd.qpd_basis.QPDBasis")]]
[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[`QPDBasis`](qiskit_addon_cutting.qpd.QPDBasis "qiskit_addon_cutting.qpd.qpd_basis.QPDBasis")]]

**Returns**

A copy of the input circuit with the specified gates replaced with [`TwoQubitQPDGate`](qiskit_addon_cutting.qpd.TwoQubitQPDGate "qiskit_addon_cutting.qpd.TwoQubitQPDGate")s and a list of [`QPDBasis`](qiskit_addon_cutting.qpd.QPDBasis "qiskit_addon_cutting.qpd.QPDBasis") instances – one for each decomposed gate.

**Raises**

[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The input circuit should contain no classical bits or registers.
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The input circuit should contain no classical bits or registers.
</Function>

Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ python_api_name: qiskit_addon_cutting.expand_observables

**Raises**

* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – `observables` and `original_circuit` have different number of qubits.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – Qubit from `original_circuit` cannot be found in `final_circuit`.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – `observables` and `original_circuit` have different number of qubits.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Qubit from `original_circuit` cannot be found in `final_circuit`.
</Function>

Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ python_api_name: qiskit_addon_cutting.find_cuts

**Return type**

[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")\[[`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")]]
[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`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)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")]]

**Returns**

Expand All @@ -35,6 +35,6 @@ python_api_name: qiskit_addon_cutting.find_cuts

**Raises**

[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The input circuit contains a gate acting on more than 2 qubits.
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The input circuit contains a gate acting on more than 2 qubits.
</Function>

Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ python_api_name: qiskit_addon_cutting.generate_cutting_experiments

**Raises**

* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)")`num_samples` must be at least one.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)")`circuits` and `observables` are incompatible types
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)")`SingleQubitQPDGate` instances must have their cut ID appended to the gate label so they may be associated with other gates belonging to the same cut.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)")`SingleQubitQPDGate` instances are not allowed in unseparated circuits.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)")`num_samples` must be at least one.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)")`circuits` and `observables` are incompatible types
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)")`SingleQubitQPDGate` instances must have their cut ID appended to the gate label so they may be associated with other gates belonging to the same cut.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)")`SingleQubitQPDGate` instances are not allowed in unseparated circuits.
</Function>

Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ python_api_name: qiskit_addon_cutting.instructions.Move

![../\_images/qiskit\_addon\_cutting-instructions-Move-1.svg](/images/api/qiskit-addon-cutting/qiskit_addon_cutting-instructions-Move-1.svg)

A full demonstration of the [`Move`](#qiskit_addon_cutting.instructions.Move "qiskit_addon_cutting.instructions.Move") instruction is available in [the introductory tutorial on wire cutting](tutorials/03_wire_cutting_via_move_instruction).
A full demonstration of the [`Move`](#qiskit_addon_cutting.instructions.Move "qiskit_addon_cutting.instructions.Move") instruction is available in [the introductory tutorial on wire cutting](https://qiskit.github.io/qiskit-addon-cutting/tutorials/03_wire_cutting_via_move_instruction.html).

Create a [`Move`](#qiskit_addon_cutting.instructions.Move "qiskit_addon_cutting.instructions.Move") instruction.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ python_api_name: qiskit_addon_cutting.partition_circuit_qubits
**Parameters**

* **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – The circuit to partition
* **partition\_labels** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[`Hashable`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable "(in Python v3.12)")]) – A sequence containing a partition label for each qubit in the input circuit. Nonlocal gates belonging to more than one partition will be replaced with [`TwoQubitQPDGate`](qiskit_addon_cutting.qpd.TwoQubitQPDGate "qiskit_addon_cutting.qpd.TwoQubitQPDGate")s.
* **inplace** ([`bool`](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Flag denoting whether to copy the input circuit before acting on it
* **partition\_labels** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[`Hashable`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable "(in Python v3.13)")]) – A sequence containing a partition label for each qubit in the input circuit. Nonlocal gates belonging to more than one partition will be replaced with [`TwoQubitQPDGate`](qiskit_addon_cutting.qpd.TwoQubitQPDGate "qiskit_addon_cutting.qpd.TwoQubitQPDGate")s.
* **inplace** ([`bool`](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Flag denoting whether to copy the input circuit before acting on it

**Return type**

Expand All @@ -31,7 +31,7 @@ python_api_name: qiskit_addon_cutting.partition_circuit_qubits

**Raises**

* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The length of partition\_labels does not equal the number of qubits in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – Input circuit contains unsupported gate.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The length of partition\_labels does not equal the number of qubits in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Input circuit contains unsupported gate.
</Function>

Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ python_api_name: qiskit_addon_cutting.partition_problem

**Raises**

* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The number of partition labels does not equal the number of qubits in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – An input observable acts on a different number of qubits than the input circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – An input observable has a phase not equal to 1.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – A qubit with a label of `None` is not idle
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The input circuit should contain no classical bits or registers.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The number of partition labels does not equal the number of qubits in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – An input observable acts on a different number of qubits than the input circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – An input observable has a phase not equal to 1.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – A qubit with a label of `None` is not idle
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The input circuit should contain no classical bits or registers.
</Function>

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ python_api_name: qiskit_addon_cutting.qpd.QPDBasis
# qiskit\_addon\_cutting.qpd.QPDBasis

<Class id="qiskit_addon_cutting.qpd.QPDBasis" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/qpd/qpd_basis.py" signature="QPDBasis(maps, coeffs)" modifiers="class">
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")

Basis in which to decompose an operation.

Expand All @@ -21,8 +21,8 @@ python_api_name: qiskit_addon_cutting.qpd.QPDBasis

**Parameters**

* **maps** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")], [`...`](https://docs.python.org/3/library/constants.html#Ellipsis "(in Python v3.12)")]]) – A sequence of tuples describing the noisy operations probabilistically used to simulate an ideal quantum operation.
* **coeffs** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")]) – Coefficients for quasiprobability representation. Each coefficient can be any real number.
* **maps** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")], [`...`](https://docs.python.org/3/library/constants.html#Ellipsis "(in Python v3.13)")]]) – A sequence of tuples describing the noisy operations probabilistically used to simulate an ideal quantum operation.
* **coeffs** ([`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")]) – Coefficients for quasiprobability representation. Each coefficient can be any real number.

**Returns**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ python_api_name: qiskit_addon_cutting.qpd.SingleQubitQPDGate

**Raises**

[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – qubit\_id is out of range
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – qubit\_id is out of range

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ python_api_name: qiskit_addon_cutting.qpd.TwoQubitQPDGate

**Raises**

[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The [`QPDBasis`](qiskit_addon_cutting.qpd.QPDBasis "qiskit_addon_cutting.qpd.QPDBasis") acts on a number of qubits not equal to 2.
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The [`QPDBasis`](qiskit_addon_cutting.qpd.QPDBasis "qiskit_addon_cutting.qpd.QPDBasis") acts on a number of qubits not equal to 2.

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ python_api_name: qiskit_addon_cutting.qpd.WeightType
# qiskit\_addon\_cutting.qpd.WeightType

<Class id="qiskit_addon_cutting.qpd.WeightType" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-addon-cutting/tree/stable/0.9/qiskit_addon_cutting/qpd/weights.py" signature="WeightType(value)" modifiers="class">
Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)")
Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)")

Type of weight associated with a QPD sample.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ python_api_name: qiskit_addon_cutting.qpd.decompose_qpd_instructions

**Raises**

* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – An index in `instruction_ids` corresponds to a gate which is not a [`BaseQPDGate`](qiskit_addon_cutting.qpd.BaseQPDGate "qiskit_addon_cutting.qpd.BaseQPDGate") instance.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – A list within instruction\_ids is not length 1 or 2.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – The total number of indices in `instruction_ids` does not equal the number of [`BaseQPDGate`](qiskit_addon_cutting.qpd.BaseQPDGate "qiskit_addon_cutting.qpd.BaseQPDGate") instances in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – Gates within the same decomposition hold different QPD bases.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – Length of `map_ids` does not equal the number of decompositions in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – An index in `instruction_ids` corresponds to a gate which is not a [`BaseQPDGate`](qiskit_addon_cutting.qpd.BaseQPDGate "qiskit_addon_cutting.qpd.BaseQPDGate") instance.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – A list within instruction\_ids is not length 1 or 2.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – The total number of indices in `instruction_ids` does not equal the number of [`BaseQPDGate`](qiskit_addon_cutting.qpd.BaseQPDGate "qiskit_addon_cutting.qpd.BaseQPDGate") instances in the circuit.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Gates within the same decomposition hold different QPD bases.
* [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Length of `map_ids` does not equal the number of decompositions in the circuit.
</Function>

Loading