Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
f351940
creates AttributeTypeHint component
eharvey328 Jul 29, 2026
c373375
use text element
eharvey328 Jul 29, 2026
4f8fae6
undo header inside attribute
eharvey328 Jul 29, 2026
a55e1eb
fix lint
eharvey328 Jul 29, 2026
a182399
remove links to default types
eharvey328 Aug 4, 2026
87dd9aa
add types in Attribute body
eharvey328 Aug 5, 2026
42341b0
undo image changes
eharvey328 Aug 5, 2026
bd31e78
Merge branch 'main' into emh/refactor-attributes
eharvey328 Aug 5, 2026
81663dc
lint
eharvey328 Aug 6, 2026
7b68d46
Merge branch 'main' into emh/refactor-attributes
eharvey328 Aug 6, 2026
a031336
wraps type hint in code
eharvey328 Aug 6, 2026
ecefe52
undo changes
eharvey328 Aug 6, 2026
31c7797
simplfy logic
eharvey328 Aug 6, 2026
61435de
fix tests
eharvey328 Aug 6, 2026
56a2886
Merge branch 'main' into emh/refactor-attributes
eharvey328 Aug 12, 2026
572ccb9
gen-api
eharvey328 Aug 12, 2026
5f19d75
use 2.5.1
eharvey328 Aug 12, 2026
22f307b
lint
eharvey328 Aug 12, 2026
7775115
wrap type and default as inline code
eharvey328 Aug 12, 2026
d50d129
lint
eharvey328 Aug 12, 2026
8038e54
Merge branch 'main' into emh/refactor-attributes
eharvey328 Aug 17, 2026
58cfa65
Merge branch 'main' into emh/refactor-attributes
eharvey328 Aug 18, 2026
b4fe735
update runtime 0.49.0
eharvey328 Aug 18, 2026
2315182
update qiskit dev
eharvey328 Aug 18, 2026
a1f1fe7
update runtime dev
eharvey328 Aug 18, 2026
5d7cd3f
update addon-utils latest
eharvey328 Aug 18, 2026
404d28e
update addon-sqd latest
eharvey328 Aug 18, 2026
503f2a7
update addon-slc latest
eharvey328 Aug 18, 2026
8cae806
update addon-paulice latest
eharvey328 Aug 18, 2026
62eb098
update addon-obp latest
eharvey328 Aug 18, 2026
d7863aa
update addon-aqc-tensor latest
eharvey328 Aug 18, 2026
4fe8f85
update pauli-props latest
eharvey328 Aug 18, 2026
168758b
undo link change
eharvey328 Aug 18, 2026
5ee9087
undo link change
eharvey328 Aug 18, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 9 additions & 3 deletions docs/api/pauli-prop/propagation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ Functions for performing Pauli propagation.

#### gates

<Attribute id="pauli_prop.propagation.RotationGates.gates" attributeTypeHint="list[ndarray[tuple[int, ...], dtype[bool]]]" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="pauli_prop.propagation.RotationGates.gates">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple)\[[`int`](https://docs.python.org/3/library/functions.html#int), ...], [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool)]]]

A ZX-calculus-like representation of the gates.
</Attribute>

Expand All @@ -77,13 +79,17 @@ Functions for performing Pauli propagation.

#### qargs

<Attribute id="pauli_prop.propagation.RotationGates.qargs" attributeTypeHint="list[list[int]]" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="pauli_prop.propagation.RotationGates.qargs">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)]]

The qubit indices acted upon by each gate.
</Attribute>

#### thetas

<Attribute id="pauli_prop.propagation.RotationGates.thetas" attributeTypeHint="list[float]" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="pauli_prop.propagation.RotationGates.thetas">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`float`](https://docs.python.org/3/library/functions.html#float)]

The rotation angles of all gates.
</Attribute>
</Class>
Expand Down
12 changes: 9 additions & 3 deletions docs/api/qiskit-addon-aqc-tensor/ansatz-generation-kak.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,21 @@ python_api_name: qiskit_addon_aqc_tensor.ansatz_generation.KAK

### ansatz\_name

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.KAK.ansatz_name" attributeValue="'KAK'" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.KAK.ansatz_name">
Default value: `'KAK'`
</Attribute>

### ansatz\_num\_params

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.KAK.ansatz_num_params" attributeValue="3" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.KAK.ansatz_num_params">
Default value: `3`
</Attribute>

### ansatz\_num\_qubits

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.KAK.ansatz_num_qubits" attributeValue="2" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.KAK.ansatz_num_qubits">
Default value: `2`
</Attribute>

### base\_class

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ python_api_name: qiskit_addon_aqc_tensor.ansatz_generation.OneQubitAnsatzBlock

### ansatz\_num\_qubits

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.OneQubitAnsatzBlock.ansatz_num_qubits" attributeValue="1" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.OneQubitAnsatzBlock.ansatz_num_qubits">
Default value: `1`
</Attribute>

### base\_class

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ python_api_name: qiskit_addon_aqc_tensor.ansatz_generation.TwoQubitAnsatzBlock

### ansatz\_num\_qubits

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.TwoQubitAnsatzBlock.ansatz_num_qubits" attributeValue="2" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.TwoQubitAnsatzBlock.ansatz_num_qubits">
Default value: `2`
</Attribute>

### base\_class

Expand Down
12 changes: 9 additions & 3 deletions docs/api/qiskit-addon-aqc-tensor/ansatz-generation-zxz.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,21 @@ python_api_name: qiskit_addon_aqc_tensor.ansatz_generation.ZXZ

### ansatz\_name

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.ZXZ.ansatz_name" attributeValue="'ZXZ'" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.ZXZ.ansatz_name">
Default value: `'ZXZ'`
</Attribute>

### ansatz\_num\_params

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.ZXZ.ansatz_num_params" attributeValue="3" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.ZXZ.ansatz_num_params">
Default value: `3`
</Attribute>

### ansatz\_num\_qubits

<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.ZXZ.ansatz_num_qubits" attributeValue="1" />
<Attribute id="qiskit_addon_aqc_tensor.ansatz_generation.ZXZ.ansatz_num_qubits">
Default value: `1`
</Attribute>

### base\_class

Expand Down
8 changes: 6 additions & 2 deletions docs/api/qiskit-addon-aqc-tensor/objective.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ $$

#### target

<Attribute id="qiskit_addon_aqc_tensor.objective.MaximizeStateFidelity.target" attributeTypeHint="TensorNetworkState">
<Attribute id="qiskit_addon_aqc_tensor.objective.MaximizeStateFidelity.target">
Type: [`TensorNetworkState`](simulation#qiskit_addon_aqc_tensor.simulation.TensorNetworkState "qiskit_addon_aqc_tensor.simulation.abstract.TensorNetworkState")

Target tensor network.
</Attribute>
</Class>
Expand Down Expand Up @@ -121,7 +123,9 @@ $$

#### target

<Attribute id="qiskit_addon_aqc_tensor.objective.OneMinusFidelity.target" attributeTypeHint="TensorNetworkState">
<Attribute id="qiskit_addon_aqc_tensor.objective.OneMinusFidelity.target">
Type: [`TensorNetworkState`](simulation#qiskit_addon_aqc_tensor.simulation.TensorNetworkState "qiskit_addon_aqc_tensor.simulation.abstract.TensorNetworkState")

Target tensor network.
</Attribute>
</Class>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,17 @@ python_api_name: qiskit_addon_aqc_tensor.simulation.aer.QiskitAerMPS

### gamma

<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerMPS.gamma" attributeTypeHint="list[tuple[ndarray, ndarray]]">
<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerMPS.gamma">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)`[`[`tuple`](https://docs.python.org/3/library/stdtypes.html#tuple)`[`[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)`,` [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)`]]`

Gamma matrices (list of 2-tuples of ndarrays, one for each site).
</Attribute>

### lamb

<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerMPS.lamb" attributeTypeHint="list[ndarray]">
<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerMPS.lamb">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)`[`[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)`]`

Lambda matrices (list of ndarrays, one for each bond between adjacent qubits).
</Attribute>
</Class>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,19 @@ python_api_name: qiskit_addon_aqc_tensor.simulation.aer.QiskitAerSimulationSetti

### callback

<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerSimulationSettings.callback" attributeTypeHint="Optional[Callable[[QuantumCircuit, Result], None]]" attributeValue="None">
<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerSimulationSettings.callback">
Type: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)`[`[`Callable`](https://docs.python.org/3/library/typing.html#typing.Callable)`[[`[`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit)`,` [`Result`](/docs/api/qiskit/qiskit.result.Result)`],` [`None`](https://docs.python.org/3/library/constants.html#None)`]]`

Default value: `None`

This callable, if provided, is called with `(circuit, result)` as arguments immediately after each MPS simulation.
</Attribute>

### simulator

<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerSimulationSettings.simulator" attributeTypeHint="AerSimulator">
<Attribute id="qiskit_addon_aqc_tensor.simulation.aer.QiskitAerSimulationSettings.simulator">
Type: [`AerSimulator`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.17.1)")

Aer simulator, must be configured with method=’matrix\_product\_state’. Stores configuration like `max_bond_dimension`, `truncation_threshold`, etc.
</Attribute>
</Class>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,27 @@ python_api_name: qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator

### autodiff\_backend

<Attribute id="qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator.autodiff_backend" attributeTypeHint="Optional[str]" attributeValue="None" />
<Attribute id="qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator.autodiff_backend">
Type: [`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional)`[`[`str`](https://docs.python.org/3/library/stdtypes.html#str)`]`

Default value: `None`
</Attribute>

### progbar

<Attribute id="qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator.progbar" attributeTypeHint="bool" attributeValue="False">
<Attribute id="qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator.progbar">
Type: [`bool`](https://docs.python.org/3/library/functions.html#bool)

Default value: `False`

Whether to display a progress bar while applying gates.
</Attribute>

### quimb\_circuit\_factory

<Attribute id="qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator.quimb_circuit_factory" attributeTypeHint="QuimbCircuitFactory">
<Attribute id="qiskit_addon_aqc_tensor.simulation.quimb.QuimbSimulator.quimb_circuit_factory">
Type: [`QuimbCircuitFactory`](simulation-quimb-quimb-circuit-factory "qiskit_addon_aqc_tensor.simulation.quimb.QuimbCircuitFactory")

Callable for constructing the Quimb circuit, e.g., `Circuit()` or `CircuitMPS()`.
</Attribute>
</Class>
Expand Down
20 changes: 15 additions & 5 deletions docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,31 +25,41 @@ python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata

### truncation\_error\_budget

<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.truncation_error_budget" attributeTypeHint="TruncationErrorBudget">
<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.truncation_error_budget">
Type: [`TruncationErrorBudget`](/docs/api/qiskit-addon-obp/utils-truncating#truncationerrorbudget "qiskit_addon_obp.utils.truncating.TruncationErrorBudget")

Values specifying the observable truncation strategy.
</Attribute>

### num\_slices

<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.num_slices" attributeTypeHint="int | None">
<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.num_slices">
Type: [`int`](https://docs.python.org/3/library/functions.html#int) | [`None`](https://docs.python.org/3/library/constants.html#None)

The total number of slices to attempt to backpropagate.
</Attribute>

### operator\_budget

<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.operator_budget" attributeTypeHint="OperatorBudget">
<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.operator_budget">
Type: [`OperatorBudget`](/docs/api/qiskit-addon-obp/utils-simplify#operatorbudget "qiskit_addon_obp.utils.simplify.OperatorBudget")

Values specifying how large the operator may grow.
</Attribute>

### backpropagation\_history

<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.backpropagation_history" attributeTypeHint="list[SliceMetadata]">
<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.backpropagation_history">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`SliceMetadata`](utils-metadata-slice-metadata "qiskit_addon_obp.utils.metadata.SliceMetadata")]

A sequence of metadata objects to track the progression of the backpropagation.
</Attribute>

### num\_backpropagated\_slices

<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.num_backpropagated_slices" attributeTypeHint="int">
<Attribute id="qiskit_addon_obp.utils.metadata.OBPMetadata.num_backpropagated_slices">
Type: [`int`](https://docs.python.org/3/library/functions.html#int)

The number of backpropagated slices.

<Admonition title="Note" type="note">
Expand Down
40 changes: 30 additions & 10 deletions docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,25 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

### slice\_errors

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.slice_errors" attributeTypeHint="list[float]">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.slice_errors">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`float`](https://docs.python.org/3/library/functions.html#float)]

The truncation error incurred for each observable that is being backpropagated.
</Attribute>

### raw\_num\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.raw_num_paulis" attributeTypeHint="list[int]">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.raw_num_paulis">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)]

The “raw” number of Pauli terms for each observable that is being backpropagated. This indicates the number of Pauli terms before any simplification or truncation operations.
</Attribute>

### num\_unique\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_unique_paulis" attributeTypeHint="list[int] | None">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_unique_paulis">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)] | [`None`](https://docs.python.org/3/library/constants.html#None)

The number of unique Pauli terms for each observable. This attribute only tracks those Pauli terms whose coefficients were not already below the trimming threshold at the beginning of the operator simplification procedure.

<Admonition title="Note" type="note">
Expand All @@ -52,7 +58,9 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

### num\_duplicate\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_duplicate_paulis" attributeTypeHint="list[int] | None">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_duplicate_paulis">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)] | [`None`](https://docs.python.org/3/library/constants.html#None)

The number of duplicate Pauli terms for each observable whose coefficients have been summed up to trim excess memory usage during the operator simplification.

<Admonition title="Note" type="note">
Expand All @@ -62,7 +70,9 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

### num\_trimmed\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_trimmed_paulis" attributeTypeHint="list[int] | None">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_trimmed_paulis">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)] | [`None`](https://docs.python.org/3/library/constants.html#None)

The number of Pauli terms for each observable that were trimmed during operator simplification because their total coefficient was below the trimming threshold.

<Admonition title="Note" type="note">
Expand All @@ -72,7 +82,9 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

### sum\_trimmed\_coeffs

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.sum_trimmed_coeffs" attributeTypeHint="list[float] | None">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.sum_trimmed_coeffs">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`float`](https://docs.python.org/3/library/functions.html#float)] | [`None`](https://docs.python.org/3/library/constants.html#None)

The sum of the coefficients for each observable that were trimmed during operator simplification because each individual coefficient was below the trimming threshold.

<Admonition title="Warning" type="caution">
Expand All @@ -86,19 +98,25 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

### num\_truncated\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_truncated_paulis" attributeTypeHint="list[int]">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_truncated_paulis">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)]

The number of Pauli terms which were truncated from each observable that is being backpropagated.
</Attribute>

### num\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_paulis" attributeTypeHint="list[int]">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_paulis">
Type: [`list`](https://docs.python.org/3/library/stdtypes.html#list)\[[`int`](https://docs.python.org/3/library/functions.html#int)]

The number of Pauli terms for each observable that is being backpropagated.
</Attribute>

### sum\_paulis

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.sum_paulis" attributeTypeHint="int | None">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.sum_paulis">
Type: [`int`](https://docs.python.org/3/library/functions.html#int) | [`None`](https://docs.python.org/3/library/constants.html#None)

The number of Pauli terms across all observables. This value is `None` if it is not bounded during the backpropagation.

<Admonition title="Note" type="note">
Expand All @@ -108,7 +126,9 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

### num\_qwc\_groups

<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_qwc_groups" attributeTypeHint="int | None">
<Attribute id="qiskit_addon_obp.utils.metadata.SliceMetadata.num_qwc_groups">
Type: [`int`](https://docs.python.org/3/library/functions.html#int) | [`None`](https://docs.python.org/3/library/constants.html#None)

The number of qubit-wise commuting groups of Pauli terms across all observables. This value is `None` if it is not bounded during the backpropagation.
</Attribute>
</Class>
Expand Down
Loading
Loading