From 51872c4b6130282f5c0948ecbe8a7f06ac78e7b0 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 8 Nov 2024 12:27:17 -0500 Subject: [PATCH] Regenerate for GitHub fixes --- .../qiskit-addon-cutting.mdx | 6 ++ docs/api/qiskit-addon-cutting/qpd.mdx | 2 + .../utils-observable-grouping.mdx | 4 + .../qiskit-addon-cutting/utils-simulation.mdx | 2 + .../qiskit-addon-cutting/utils-transforms.mdx | 2 + docs/api/qiskit-addon-mpf/static.mdx | 10 +-- .../api/qiskit-addon-obp/qiskit-addon-obp.mdx | 2 +- .../utils-metadata-obp-metadata.mdx | 10 +-- .../utils-metadata-slice-metadata.mdx | 2 +- .../api/qiskit-addon-obp/utils-operations.mdx | 8 +- docs/api/qiskit-addon-obp/utils-simplify.mdx | 8 +- .../api/qiskit-addon-obp/utils-truncating.mdx | 8 +- .../qiskit-addon-obp/utils-visualization.mdx | 14 +-- .../0.7/configuration-recovery.mdx | 4 +- docs/api/qiskit-addon-sqd/0.7/counts.mdx | 8 +- docs/api/qiskit-addon-sqd/0.7/fermion.mdx | 14 +-- docs/api/qiskit-addon-sqd/0.7/qubit.mdx | 8 +- docs/api/qiskit-addon-sqd/0.7/subsampling.mdx | 4 +- .../configuration-recovery.mdx | 4 +- docs/api/qiskit-addon-sqd/counts.mdx | 8 +- docs/api/qiskit-addon-sqd/fermion.mdx | 20 ++--- docs/api/qiskit-addon-sqd/qubit.mdx | 8 +- docs/api/qiskit-addon-sqd/subsampling.mdx | 4 +- docs/api/qiskit-addon-utils/coloring.mdx | 4 +- .../qiskit-addon-utils/problem-generators.mdx | 6 +- docs/api/qiskit-addon-utils/release-notes.mdx | 12 +++ ...ing-transpiler-passes-collect-op-color.mdx | 2 +- ...cing-transpiler-passes-collect-op-size.mdx | 2 +- ...cing-transpiler-passes-collect-op-type.mdx | 2 +- docs/api/qiskit-addon-utils/slicing.mdx | 10 +-- ...skit_addon_cutting-instructions-Move-1.svg | 86 +++++++++---------- 31 files changed, 156 insertions(+), 128 deletions(-) diff --git a/docs/api/qiskit-addon-cutting/qiskit-addon-cutting.mdx b/docs/api/qiskit-addon-cutting/qiskit-addon-cutting.mdx index e879d519a61..46f96be4bd1 100644 --- a/docs/api/qiskit-addon-cutting/qiskit-addon-cutting.mdx +++ b/docs/api/qiskit-addon-cutting/qiskit-addon-cutting.mdx @@ -231,6 +231,8 @@ Circuit cutting. ### PartitionedCuttingProblem + 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). Create new instance of PartitionedCuttingProblem(subcircuits, bases, subobservables) @@ -309,6 +311,8 @@ Circuit cutting. ### OptimizationParameters + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Specify parameters that control the optimization. If either of the constraints specified by `max_backjumps` or `max_gamma` are exceeded, the search terminates but nevertheless returns the result of a greedy best first search, which gives an *upper-bound* on gamma. @@ -355,6 +359,8 @@ Circuit cutting. ### DeviceConstraints + 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. **Parameters** diff --git a/docs/api/qiskit-addon-cutting/qpd.mdx b/docs/api/qiskit-addon-cutting/qpd.mdx index ddbe0355780..f21559227e5 100644 --- a/docs/api/qiskit-addon-cutting/qpd.mdx +++ b/docs/api/qiskit-addon-cutting/qpd.mdx @@ -26,6 +26,8 @@ Main quasiprobability decomposition functionality. ### WeightType + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Type of weight associated with a QPD sample. #### EXACT diff --git a/docs/api/qiskit-addon-cutting/utils-observable-grouping.mdx b/docs/api/qiskit-addon-cutting/utils-observable-grouping.mdx index 5bced0c2586..39687e81699 100644 --- a/docs/api/qiskit-addon-cutting/utils-observable-grouping.mdx +++ b/docs/api/qiskit-addon-cutting/utils-observable-grouping.mdx @@ -47,6 +47,8 @@ Module for conducting Pauli observable grouping. ### CommutingObservableGroup + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Set of mutually qubit-wise commuting observables. **Parameters** @@ -82,6 +84,8 @@ Module for conducting Pauli observable grouping. ### ObservableCollection + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Collection of observables organized for efficient taking of measurements. The observables are automatically organized into sets of mutually qubit-wise commuting observables, each represented by a [`CommutingObservableGroup`](#qiskit_addon_cutting.utils.observable_grouping.CommutingObservableGroup "qiskit_addon_cutting.utils.observable_grouping.CommutingObservableGroup"). diff --git a/docs/api/qiskit-addon-cutting/utils-simulation.mdx b/docs/api/qiskit-addon-cutting/utils-simulation.mdx index 3d6d802316f..59588a686e9 100644 --- a/docs/api/qiskit-addon-cutting/utils-simulation.mdx +++ b/docs/api/qiskit-addon-cutting/utils-simulation.mdx @@ -37,6 +37,8 @@ Simulation of precise measurement outcome probabilities. ### ExactSampler + Bases: [`BaseSamplerV1`](/api/qiskit/qiskit.primitives.BaseSamplerV1 "(in Qiskit v1.2)") + Sampler which returns exact probabilities for each possible outcome. This sampler supports: diff --git a/docs/api/qiskit-addon-cutting/utils-transforms.mdx b/docs/api/qiskit-addon-cutting/utils-transforms.mdx index 937b2455ce2..01861e8765e 100644 --- a/docs/api/qiskit-addon-cutting/utils-transforms.mdx +++ b/docs/api/qiskit-addon-cutting/utils-transforms.mdx @@ -67,6 +67,8 @@ Functions for manipulating quantum circuits. ### SeparatedCircuits + Bases: [`NamedTuple`](https://docs.python.org/3/library/typing.html#typing.NamedTuple "(in Python v3.13)") + Named tuple for result of [`separate_circuit()`](#qiskit_addon_cutting.utils.transforms.separate_circuit "qiskit_addon_cutting.utils.transforms.separate_circuit"). `subcircuits` is a dict of circuits, keyed by each partition label. `qubit_map` is a list with length equal to the number of qubits in the original circuit. Each element of that list is a 2-tuple which includes the partition label of that qubit, together with the index of that qubit in the corresponding subcircuit. If the original qubit is unused and has been removed from the separated circuits, then that tuple will be equal to `(None, None)`. diff --git a/docs/api/qiskit-addon-mpf/static.mdx b/docs/api/qiskit-addon-mpf/static.mdx index e7a0e466e86..b84043d5e89 100644 --- a/docs/api/qiskit-addon-mpf/static.mdx +++ b/docs/api/qiskit-addon-mpf/static.mdx @@ -20,7 +20,7 @@ Static MPFs. ### LSE - + A `namedtuple` representing a linear system of equations. $$ @@ -62,7 +62,7 @@ $$ #### solve - + Return the solution to this LSE: $x=A^{-1}b$. **Returns** @@ -87,7 +87,7 @@ $$ ### setup\_lse - + Return the linear system of equations for computing the static MPF coefficients. This function constructs the following linear system of equations: @@ -139,7 +139,7 @@ $$ ### setup\_exact\_model - + Construct a [`cvxpy.Problem`](https://www.cvxpy.org/api_reference/cvxpy.problems.html#cvxpy.Problem "(in CVXPY v1.5)") for finding exact static MPF coefficients. @@ -200,7 +200,7 @@ $$ ### setup\_approximate\_model - + Construct a [`cvxpy.Problem`](https://www.cvxpy.org/api_reference/cvxpy.problems.html#cvxpy.Problem "(in CVXPY v1.5)") for finding approximate static MPF coefficients. The optimization problem constructed by this class is defined as follows: diff --git a/docs/api/qiskit-addon-obp/qiskit-addon-obp.mdx b/docs/api/qiskit-addon-obp/qiskit-addon-obp.mdx index ab4c47b7424..a3d1ff0befb 100644 --- a/docs/api/qiskit-addon-obp/qiskit-addon-obp.mdx +++ b/docs/api/qiskit-addon-obp/qiskit-addon-obp.mdx @@ -18,7 +18,7 @@ Main operator backpropagation functionality. ### backpropagate - + Backpropagate slices of quantum circuit operations onto the provided observables. This function takes a (list of) observable(s) and backpropagates the provided quantum circuit slices **in reverse order** onto the observable(s) until one of the stopping criteria is reached. diff --git a/docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx b/docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx index c29e9a14000..905163ad3ac 100644 --- a/docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx +++ b/docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata # OBPMetadata - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") A container for metadata generated during the `backpropagate()` method. @@ -61,7 +61,7 @@ python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata ### accumulated\_error - + Compute the accumulated error for a given observable at a given “time”. This method computes the accumulated error for a given observable index at a given “time” during the course of the backpropagation. In this context, “time” is to be understood as the discrete steps of already backpropagated slices. @@ -88,7 +88,7 @@ python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata ### from\_json - + Load a metadata from a json file. **Parameters** @@ -106,7 +106,7 @@ python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata ### left\_over\_error\_budget - + Compute the left-over error budget for a given observable at a given “time”. This method computes the left-over error budget for a given observable index at a given “time” during the course of the backpropagation. In this context, “time” is to be understood as the discrete steps of already backpropagated slices. @@ -137,7 +137,7 @@ python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata ### to\_json - + Dump this metadata to a json file. **Parameters** diff --git a/docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx b/docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx index acdbfef04ce..f50f91e3efb 100644 --- a/docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx +++ b/docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata # SliceMetadata - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") A container for metadata generated during the backpropagation of a single slice. diff --git a/docs/api/qiskit-addon-obp/utils-operations.mdx b/docs/api/qiskit-addon-obp/utils-operations.mdx index 0b26ff9d6bb..e8f2152de88 100644 --- a/docs/api/qiskit-addon-obp/utils-operations.mdx +++ b/docs/api/qiskit-addon-obp/utils-operations.mdx @@ -18,7 +18,7 @@ Utility functions for operator backpropagation. ### apply\_op\_to - + Apply the operator `op2` to the operator `op1`. These operators do not necessarily need to act on the same number of qubits, as they are assumed to act on a larger system. The position in the system of each operator is defined by the corresponding `qargs`. The output operator will be defined on `union(op1_qargs, op2_qargs)`. @@ -56,7 +56,7 @@ Utility functions for operator backpropagation. ### apply\_reset\_to - + Apply a reset operation to a Pauli operator. This function applies a reset operation to `op` in the following way: @@ -82,7 +82,7 @@ Utility functions for operator backpropagation. ### to\_global\_op - + Convert a local operator to a global operator by inserting identities on qubits which aren’t used. **Parameters** @@ -106,7 +106,7 @@ Utility functions for operator backpropagation. ### reduce\_op - + Create a lean representation of a global Pauli operator. This function returns a lean representation of the input operator such that all of the qubits associated solely with Pauli-I terms have been removed. A list of indices is also returned indicating on which qubits the lean operator acts. diff --git a/docs/api/qiskit-addon-obp/utils-simplify.mdx b/docs/api/qiskit-addon-obp/utils-simplify.mdx index 1701fb8300e..265b8b57771 100644 --- a/docs/api/qiskit-addon-obp/utils-simplify.mdx +++ b/docs/api/qiskit-addon-obp/utils-simplify.mdx @@ -18,7 +18,7 @@ Functions for simplifying Pauli operators. ### OperatorBudget - + A class for storing the constants that determine how large an operator may grow. Backpropagation will stop if either of the following conditions is met: @@ -34,7 +34,7 @@ Functions for simplifying Pauli operators. #### is\_active - + Return whether `self` places any bounds on operator size. **Return type** @@ -63,7 +63,7 @@ Functions for simplifying Pauli operators. ### SimplifyMetadata - + A simple dataclass for returning the tracked attributes during operator simplification. **Parameters** @@ -100,7 +100,7 @@ Functions for simplifying Pauli operators. ### simplify - + Simplifies the provided Pauli operator. This is an adaption of `SparsePauliOp.simplify()` which tracks metadata of the simplified terms. diff --git a/docs/api/qiskit-addon-obp/utils-truncating.mdx b/docs/api/qiskit-addon-obp/utils-truncating.mdx index 97eb44fa911..2b9c5d38a90 100644 --- a/docs/api/qiskit-addon-obp/utils-truncating.mdx +++ b/docs/api/qiskit-addon-obp/utils-truncating.mdx @@ -18,7 +18,7 @@ Functions for truncating Pauli operators within given error budgets. ### TruncationErrorBudget - + A class for storing the constants that determine the truncation error budget. Refer to the [how-to guide](https://qiskit.github.io/qiskit-addon-obp/how_tos/truncate_operator_terms.html) for a detailed discussion on truncating operator terms during backpropagation and bounding the incurred error. @@ -31,7 +31,7 @@ Functions for truncating Pauli operators within given error budgets. #### is\_active - + Return whether the truncation is active, i.e. whether the budget is non-zero. **Return type** @@ -62,7 +62,7 @@ Functions for truncating Pauli operators within given error budgets. ### setup\_budget - + Calculate the budget available to each slice for observable term truncation. This method makes the construction of a [`TruncationErrorBudget`](#qiskit_addon_obp.utils.truncating.TruncationErrorBudget "qiskit_addon_obp.utils.truncating.TruncationErrorBudget") easier for an end-user. This error budget can be provided to the [`backpropagate()`](qiskit-addon-obp#backpropagate "qiskit_addon_obp.backpropagate") method to enable the truncation of low-weight Pauli terms. Refer to the [how-to guide](https://qiskit.github.io/qiskit-addon-obp/how_tos/truncate_operator_terms.html) for a detailed discussion on truncating terms from the output operator and bounding the incurred error. @@ -102,7 +102,7 @@ Functions for truncating Pauli operators within given error budgets. ### truncate\_binary\_search - + Perform binary search to find an optimal observable truncation threshold. Removes the Pauli terms from a `SparsePauliOp` whose sum of their absolute coefficients values does not exceed the provided error `budget`. diff --git a/docs/api/qiskit-addon-obp/utils-visualization.mdx b/docs/api/qiskit-addon-obp/utils-visualization.mdx index 65534b392d5..5d04ea083cd 100644 --- a/docs/api/qiskit-addon-obp/utils-visualization.mdx +++ b/docs/api/qiskit-addon-obp/utils-visualization.mdx @@ -18,7 +18,7 @@ Various visualization utilities. ### plot\_accumulated\_error - + Plot the accumulated error. This method populates the provided figure axes with a line-plot of the [`OBPMetadata.accumulated_error()`](utils-metadata-obp-metadata#accumulated_error "qiskit_addon_obp.utils.metadata.OBPMetadata.accumulated_error"). Below is an example where we plot some `metadata` which exists within our context. @@ -48,7 +48,7 @@ Various visualization utilities. ### plot\_left\_over\_error\_budget - + Plot the left-over error budget. This method populates the provided figure axes with a line-plot of the [`OBPMetadata.left_over_error_budget()`](utils-metadata-obp-metadata#left_over_error_budget "qiskit_addon_obp.utils.metadata.OBPMetadata.left_over_error_budget"). Below is an example where we plot some `metadata` which exists within our context. @@ -78,7 +78,7 @@ Various visualization utilities. ### plot\_slice\_errors - + Plot the slice errors. This method populates the provided figure axes with a bar-plot of the truncation error incurred at each backpropagated slice. Below is an example where we plot some `metadata` which exists within our context. @@ -112,7 +112,7 @@ Various visualization utilities. ### plot\_num\_paulis - + Plot the number of Pauli terms. This method populates the provided figure axes with a line-plot of the number of Pauli terms at each backpropagated slice. Below is an example where we plot some `metadata` which exists within our context. @@ -148,7 +148,7 @@ Various visualization utilities. ### plot\_num\_truncated\_paulis - + Plot the number of truncated Pauli terms. This method populates the provided figure axes with a bar-plot of the number of the truncated Pauli terms at each backpropagated slice. Below is an example where we plot some `metadata` which exists within our context. @@ -186,7 +186,7 @@ Various visualization utilities. ### plot\_sum\_paulis - + Plot the total number of all Pauli terms. This method populates the provided figure axes with a line-plot of the total number of all Pauli terms at each backpropagated slice. Below is an example where we plot some `metadata` which exists within our context. @@ -226,7 +226,7 @@ Various visualization utilities. ### plot\_num\_qwc\_groups - + Plot the number of qubit-wise commuting Pauli groups. This method populates the provided figure axes with a line-plot of the number of qubit-wise commuting Pauli groups at each backpropagated slice. Below is an example where we plot some `metadata` which exists within our context. diff --git a/docs/api/qiskit-addon-sqd/0.7/configuration-recovery.mdx b/docs/api/qiskit-addon-sqd/0.7/configuration-recovery.mdx index 15f90410130..37f6f7d1881 100644 --- a/docs/api/qiskit-addon-sqd/0.7/configuration-recovery.mdx +++ b/docs/api/qiskit-addon-sqd/0.7/configuration-recovery.mdx @@ -18,7 +18,7 @@ Functions for performing self-consistent configuration recovery. ### post\_select\_by\_hamming\_weight - + Post-select bitstrings based on the hamming weight of each half. **Parameters** @@ -38,7 +38,7 @@ Functions for performing self-consistent configuration recovery. ### recover\_configurations - + Refine bitstrings based on average orbital occupancy and a target hamming weight. This function refines each bit in isolation in an attempt to transform the Hilbert space represented by the input `bitstring_matrix` into a space closer to that which supports the ground state. diff --git a/docs/api/qiskit-addon-sqd/0.7/counts.mdx b/docs/api/qiskit-addon-sqd/0.7/counts.mdx index 6e6b6eb1ca8..f837bac2773 100644 --- a/docs/api/qiskit-addon-sqd/0.7/counts.mdx +++ b/docs/api/qiskit-addon-sqd/0.7/counts.mdx @@ -18,7 +18,7 @@ Functions for transforming counts dictionaries. ### counts\_to\_arrays - + Convert a counts dictionary into a bitstring matrix and a probability array. **Parameters** @@ -37,7 +37,7 @@ Functions for transforming counts dictionaries. ### generate\_counts\_uniform - + Generate a bitstring counts dictionary of samples drawn from the uniform distribution. **Parameters** @@ -61,7 +61,7 @@ Functions for transforming counts dictionaries. ### generate\_counts\_bipartite\_hamming - + Generate a bitstring counts dictionary with specified bipartite hamming weight. **Parameters** @@ -89,7 +89,7 @@ Functions for transforming counts dictionaries. ### normalize\_counts\_dict - + Convert a counts dictionary into a probability dictionary. **Parameters** diff --git a/docs/api/qiskit-addon-sqd/0.7/fermion.mdx b/docs/api/qiskit-addon-sqd/0.7/fermion.mdx index fedac1fc814..d78b3b1ff81 100644 --- a/docs/api/qiskit-addon-sqd/0.7/fermion.mdx +++ b/docs/api/qiskit-addon-sqd/0.7/fermion.mdx @@ -18,7 +18,7 @@ Functions for the study of fermionic systems. ### bitstring\_matrix\_to\_ci\_strs - + Convert bitstrings (rows) in a `bitstring_matrix` into integer representations of determinants. This function separates each bitstring in `bitstring_matrix` in half, flips the bits and translates them into integer representations, and finally appends them to their respective (spin-up or spin-down) lists. Those lists are sorted and output from this function. @@ -39,7 +39,7 @@ Functions for the study of fermionic systems. ### enlarge\_batch\_from\_transitions - + Apply the set of transition operators to the configurations represented in `bitstring_matrix`. **Parameters** @@ -58,7 +58,7 @@ Functions for the study of fermionic systems. ### flip\_orbital\_occupancies - + Flip an orbital occupancy array to match the indexing of a bitstring. This function reformats a 1D array of spin-orbital occupancies formatted like: @@ -82,7 +82,7 @@ Functions for the study of fermionic systems. ### solve\_fermion - + Approximate the ground state given molecular integrals and a set of electronic configurations. **Parameters** @@ -119,7 +119,7 @@ Functions for the study of fermionic systems. ### optimize\_orbitals - + Optimize orbitals to produce a minimal ground state. The process involves iterating over 3 steps: @@ -171,7 +171,7 @@ Functions for the study of fermionic systems. ### rotate\_integrals - + Perform a similarity transform on the integrals. The transformation is described as: @@ -204,7 +204,7 @@ $$ ### bitstring\_matrix\_to\_sorted\_addresses - + Convert a bitstring matrix into a sorted array of unique, unsigned integers. This function separates each bitstring in `bitstring_matrix` in half, flips the bits and translates them into integer representations, and finally appends them to their respective (spin-up or spin-down) lists. Those lists are sorted and output from this function. diff --git a/docs/api/qiskit-addon-sqd/0.7/qubit.mdx b/docs/api/qiskit-addon-sqd/0.7/qubit.mdx index 289deb32315..70a32e1e175 100644 --- a/docs/api/qiskit-addon-sqd/0.7/qubit.mdx +++ b/docs/api/qiskit-addon-sqd/0.7/qubit.mdx @@ -18,7 +18,7 @@ Functions for handling quantum samples. ### solve\_qubit - + Find the energies and eigenstates of a Hamiltonian projected into a subspace. The subspace is defined by a collection of computational basis states which are specified by the bitstrings (rows) in the `bitstring_matrix`. @@ -53,7 +53,7 @@ Functions for handling quantum samples. ### project\_operator\_to\_subspace - + Project a Pauli operator onto a Hilbert subspace defined by the computational basis states (rows) in `bitstring_matrix`. The output sparse matrix, `A`, represents an `NxN` matrix s.t. `N` is the number of rows in `bitstring_matrix`. The rows of `A` represent the input configurations, and the columns represent the connected component associated with the configuration in the corresponding row. The non-zero elements of the matrix represent the complex amplitudes associated with the connected components. @@ -87,7 +87,7 @@ Functions for handling quantum samples. ### sort\_and\_remove\_duplicates - + Sort a bitstring matrix and remove duplicate entries. The lowest bitstring values will be placed in the lowest-indexed rows. @@ -107,7 +107,7 @@ Functions for handling quantum samples. ### matrix\_elements\_from\_pauli - + Find the sparse matrix elements of a Pauli operator in the subspace defined by the bitstrings. The sparse matrix, `A`, defined by the outputs represents an `NxN` matrix s.t. `N` is the number of rows in `bitstring_matrix`. The rows of `A` represent the input configurations, and the columns represent the connected component associated with the configuration in the corresponding row. The output arrays define the sparse matrix, `A`, as follows: diff --git a/docs/api/qiskit-addon-sqd/0.7/subsampling.mdx b/docs/api/qiskit-addon-sqd/0.7/subsampling.mdx index 920d8a017a4..7febb49b120 100644 --- a/docs/api/qiskit-addon-sqd/0.7/subsampling.mdx +++ b/docs/api/qiskit-addon-sqd/0.7/subsampling.mdx @@ -18,7 +18,7 @@ Functions for creating batches of samples from a bitstring matrix. ### subsample - + Subsample batches of bit arrays from an input `bitstring_matrix`. Each individual batch will be sampled without replacement from the input `bitstring_matrix`. Samples will be replaced after creation of each batch, so different batches may contain identical samples. @@ -47,7 +47,7 @@ Functions for creating batches of samples from a bitstring matrix. ### postselect\_and\_subsample - + Subsample batches of bit arrays with correct hamming weight from an input `bitstring_matrix`. Bitstring samples with incorrect hamming weight on either their left or right half will not be sampled. diff --git a/docs/api/qiskit-addon-sqd/configuration-recovery.mdx b/docs/api/qiskit-addon-sqd/configuration-recovery.mdx index f4144c75a95..d493ca1410e 100644 --- a/docs/api/qiskit-addon-sqd/configuration-recovery.mdx +++ b/docs/api/qiskit-addon-sqd/configuration-recovery.mdx @@ -18,7 +18,7 @@ Functions for performing self-consistent configuration recovery. ### post\_select\_by\_hamming\_weight - + Post-select bitstrings based on the hamming weight of each half. **Parameters** @@ -38,7 +38,7 @@ Functions for performing self-consistent configuration recovery. ### recover\_configurations - + Refine bitstrings based on average orbital occupancy and a target hamming weight. This function refines each bit in isolation in an attempt to transform the Hilbert space represented by the input `bitstring_matrix` into a space closer to that which supports the ground state. diff --git a/docs/api/qiskit-addon-sqd/counts.mdx b/docs/api/qiskit-addon-sqd/counts.mdx index dc3d9cb16cc..1bf347a0675 100644 --- a/docs/api/qiskit-addon-sqd/counts.mdx +++ b/docs/api/qiskit-addon-sqd/counts.mdx @@ -18,7 +18,7 @@ Functions for transforming counts dictionaries. ### counts\_to\_arrays - + Convert a counts dictionary into a bitstring matrix and a probability array. **Parameters** @@ -37,7 +37,7 @@ Functions for transforming counts dictionaries. ### generate\_counts\_uniform - + Generate a bitstring counts dictionary of samples drawn from the uniform distribution. **Parameters** @@ -61,7 +61,7 @@ Functions for transforming counts dictionaries. ### generate\_counts\_bipartite\_hamming - + Generate a bitstring counts dictionary with specified bipartite hamming weight. **Parameters** @@ -89,7 +89,7 @@ Functions for transforming counts dictionaries. ### normalize\_counts\_dict - + Convert a counts dictionary into a probability dictionary. **Parameters** diff --git a/docs/api/qiskit-addon-sqd/fermion.mdx b/docs/api/qiskit-addon-sqd/fermion.mdx index e4604c0fd37..9e9258fc16a 100644 --- a/docs/api/qiskit-addon-sqd/fermion.mdx +++ b/docs/api/qiskit-addon-sqd/fermion.mdx @@ -18,7 +18,7 @@ Functions for the study of fermionic systems. ### SCIState - + The amplitudes and determinants describing a quantum state. **Parameters** @@ -47,20 +47,20 @@ Functions for the study of fermionic systems. #### load - + Load an SCIState object from an .npz file. #### save - + Save the SCIState object to an .npz file. ### bitstring\_matrix\_to\_ci\_strs - + Convert bitstrings (rows) in a `bitstring_matrix` into integer representations of determinants. This function separates each bitstring in `bitstring_matrix` in half, flips the bits and translates them into integer representations, and finally appends them to their respective (spin-up or spin-down) lists. Those lists are sorted and output from this function. @@ -81,7 +81,7 @@ Functions for the study of fermionic systems. ### enlarge\_batch\_from\_transitions - + Apply the set of transition operators to the configurations represented in `bitstring_matrix`. **Parameters** @@ -100,7 +100,7 @@ Functions for the study of fermionic systems. ### flip\_orbital\_occupancies - + Flip an orbital occupancy array to match the indexing of a bitstring. This function reformats a 1D array of spin-orbital occupancies formatted like: @@ -124,7 +124,7 @@ Functions for the study of fermionic systems. ### solve\_fermion - + Approximate the ground state given molecular integrals and a set of electronic configurations. **Parameters** @@ -161,7 +161,7 @@ Functions for the study of fermionic systems. ### optimize\_orbitals - + Optimize orbitals to produce a minimal ground state. The process involves iterating over 3 steps: @@ -213,7 +213,7 @@ Functions for the study of fermionic systems. ### rotate\_integrals - + Perform a similarity transform on the integrals. The transformation is described as: @@ -246,7 +246,7 @@ $$ ### bitstring\_matrix\_to\_sorted\_addresses - + Convert a bitstring matrix into a sorted array of unique, unsigned integers. This function separates each bitstring in `bitstring_matrix` in half, flips the bits and translates them into integer representations, and finally appends them to their respective (spin-up or spin-down) lists. Those lists are sorted and output from this function. diff --git a/docs/api/qiskit-addon-sqd/qubit.mdx b/docs/api/qiskit-addon-sqd/qubit.mdx index 29979e0718a..a811ef13b94 100644 --- a/docs/api/qiskit-addon-sqd/qubit.mdx +++ b/docs/api/qiskit-addon-sqd/qubit.mdx @@ -18,7 +18,7 @@ Functions for handling quantum samples. ### solve\_qubit - + Find the energies and eigenstates of a Hamiltonian projected into a subspace. The subspace is defined by a collection of computational basis states which are specified by the bitstrings (rows) in the `bitstring_matrix`. @@ -53,7 +53,7 @@ Functions for handling quantum samples. ### project\_operator\_to\_subspace - + Project a Pauli operator onto a Hilbert subspace defined by the computational basis states (rows) in `bitstring_matrix`. The output sparse matrix, `A`, represents an `NxN` matrix s.t. `N` is the number of rows in `bitstring_matrix`. The rows of `A` represent the input configurations, and the columns represent the connected component associated with the configuration in the corresponding row. The non-zero elements of the matrix represent the complex amplitudes associated with the connected components. @@ -87,7 +87,7 @@ Functions for handling quantum samples. ### sort\_and\_remove\_duplicates - + Sort a bitstring matrix and remove duplicate entries. The lowest bitstring values will be placed in the lowest-indexed rows. @@ -107,7 +107,7 @@ Functions for handling quantum samples. ### matrix\_elements\_from\_pauli - + Find the sparse matrix elements of a Pauli operator in the subspace defined by the bitstrings. The sparse matrix, `A`, defined by the outputs represents an `NxN` matrix s.t. `N` is the number of rows in `bitstring_matrix`. The rows of `A` represent the input configurations, and the columns represent the connected component associated with the configuration in the corresponding row. The output arrays define the sparse matrix, `A`, as follows: diff --git a/docs/api/qiskit-addon-sqd/subsampling.mdx b/docs/api/qiskit-addon-sqd/subsampling.mdx index e6ca0098866..c26bb83402a 100644 --- a/docs/api/qiskit-addon-sqd/subsampling.mdx +++ b/docs/api/qiskit-addon-sqd/subsampling.mdx @@ -18,7 +18,7 @@ Functions for creating batches of samples from a bitstring matrix. ### subsample - + Subsample batches of bit arrays from an input `bitstring_matrix`. Each individual batch will be sampled without replacement from the input `bitstring_matrix`. Samples will be replaced after creation of each batch, so different batches may contain identical samples. @@ -47,7 +47,7 @@ Functions for creating batches of samples from a bitstring matrix. ### postselect\_and\_subsample - + Subsample batches of bit arrays with correct hamming weight from an input `bitstring_matrix`. Bitstring samples with incorrect hamming weight on either their left or right half will not be sampled. diff --git a/docs/api/qiskit-addon-utils/coloring.mdx b/docs/api/qiskit-addon-utils/coloring.mdx index df9bba0eb12..5b587290600 100644 --- a/docs/api/qiskit-addon-utils/coloring.mdx +++ b/docs/api/qiskit-addon-utils/coloring.mdx @@ -18,7 +18,7 @@ Utility methods for coloring. ### auto\_color\_edges - + Color the input edges of an undirected graph such that no two incident edges share a color. **Parameters** @@ -36,7 +36,7 @@ Utility methods for coloring. ### is\_valid\_edge\_coloring - + Check whether an edge coloring scheme is valid. An edge coloring is valid if no two edges of the same color share a node. diff --git a/docs/api/qiskit-addon-utils/problem-generators.mdx b/docs/api/qiskit-addon-utils/problem-generators.mdx index 0856dd70842..db19722751b 100644 --- a/docs/api/qiskit-addon-utils/problem-generators.mdx +++ b/docs/api/qiskit-addon-utils/problem-generators.mdx @@ -18,7 +18,7 @@ Utility methods for problem generation. ### generate\_xyz\_hamiltonian - + Generate a connectivity-aware qubit operator representing a quantum XYZ-type model. This function implements the following Hamiltonian: @@ -83,7 +83,7 @@ $$ ### generate\_time\_evolution\_circuit - + Model the time evolution of an operator. ```python @@ -133,7 +133,7 @@ $$ ### PauliOrderStrategy - + Enumeration of different Pauli-orderings. When constructing a Hamiltonian on a colored set of edges, the generated Pauli terms can be ordered in different ways. This order of terms in the Hamiltonian is preserved during its time evolution and, thus, directly impacts the resulting quantum circuit. diff --git a/docs/api/qiskit-addon-utils/release-notes.mdx b/docs/api/qiskit-addon-utils/release-notes.mdx index 5cb87419930..993c56d28be 100644 --- a/docs/api/qiskit-addon-utils/release-notes.mdx +++ b/docs/api/qiskit-addon-utils/release-notes.mdx @@ -10,6 +10,18 @@ in_page_toc_max_heading_level: 2 # Qiskit addon utilities release notes + + + + +## Upcoming release (`stable/0.1`) + + + +### Other Notes + +* This release adds support for Python 3.13. No code changes were necessary, so older releases are expected to work on Python 3.13 too. + diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-color.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-color.mdx index c9663a96074..9ac4350f74f 100644 --- a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-color.mdx +++ b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-color.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpColor # CollectOpColor - + Bases: [`CollectAndCollapse`](/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse "(in Qiskit v1.2)") Collects blocks of operations which act on the provided edges. diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-size.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-size.mdx index 50feb73ab3b..c391527326e 100644 --- a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-size.mdx +++ b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-size.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize # CollectOpSize - + Bases: [`CollectAndCollapse`](/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse "(in Qiskit v1.2)") Collects blocks of the specified size and replaces them by a single block instruction. diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-type.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-type.mdx index c909c36de27..10ec0150c70 100644 --- a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-type.mdx +++ b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-type.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpType # CollectOpType - + Bases: [`CollectAndCollapse`](/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse "(in Qiskit v1.2)") Collects blocks of the specified operation and replaces them by a single block instruction. diff --git a/docs/api/qiskit-addon-utils/slicing.mdx b/docs/api/qiskit-addon-utils/slicing.mdx index 6945881fa6d..a9c3243515f 100644 --- a/docs/api/qiskit-addon-utils/slicing.mdx +++ b/docs/api/qiskit-addon-utils/slicing.mdx @@ -20,7 +20,7 @@ For more information, check out the [how-to guide](https://qiskit.github.io/qisk ### combine\_slices - + Combine N-qubit slices of a circuit into a single circuit. **Parameters** @@ -43,7 +43,7 @@ For more information, check out the [how-to guide](https://qiskit.github.io/qisk ### slice\_by\_barriers - + Split a `QuantumCircuit` into slices around full-circuit barriers. Barriers which do not act on all circuit qubits will be treated as normal operations and included in the slices. Barriers which act on all qubits will be interpreted as slice locations and will not be included in the output slices. @@ -63,7 +63,7 @@ For more information, check out the [how-to guide](https://qiskit.github.io/qisk ### slice\_by\_coloring - + Split a `QuantumCircuit` into slices using the provided edge coloring. Two-qubit gates acting on identically colored qubit connections (edges) will be grouped greedily into slices using [`CollectOpColor`](slicing-transpiler-passes-collect-op-color "qiskit_addon_utils.slicing.transpiler.passes.CollectOpColor"). This will be done in order of increasing color value (the integer values which each edge is mapped to). @@ -137,7 +137,7 @@ For more information, check out the [how-to guide](https://qiskit.github.io/qisk ### slice\_by\_depth - + Split a `QuantumCircuit` into slices based on depth. This function transforms the input circuit into a [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") and batches the sequence of depth-1 layers output from [`layers()`](/api/qiskit/qiskit.dagcircuit.DAGCircuit#layers "(in Qiskit v1.2)") into slices of depth not exceeding `max_slice_depth`. This is achieved by composing layers into slices until the max slice depth is reached and then starting a new slice with the next layer. The final slice may be composed of fewer than `max_slice_depth` layers. @@ -158,7 +158,7 @@ For more information, check out the [how-to guide](https://qiskit.github.io/qisk ### slice\_by\_gate\_types - + Split a `QuantumCircuit` into depth-1 slices of operations of the same type. diff --git a/public/images/api/qiskit-addon-cutting/qiskit_addon_cutting-instructions-Move-1.svg b/public/images/api/qiskit-addon-cutting/qiskit_addon_cutting-instructions-Move-1.svg index 46bbc70d51f..ae2baf64590 100644 --- a/public/images/api/qiskit-addon-cutting/qiskit_addon_cutting-instructions-Move-1.svg +++ b/public/images/api/qiskit-addon-cutting/qiskit_addon_cutting-instructions-Move-1.svg @@ -6,7 +6,7 @@ - 2024-11-05T10:03:09.799402 + 2024-11-08T16:31:39.351987 image/svg+xml @@ -32,22 +32,22 @@ z +" clip-path="url(#pc9f8534521)" style="fill: none; stroke: #000000; stroke-width: 2; stroke-linecap: square"/> +" clip-path="url(#pc9f8534521)" style="fill: none; stroke: #000000; stroke-width: 2; stroke-linecap: square"/> +" clip-path="url(#pc9f8534521)" style="fill: none; stroke: #000000; stroke-width: 2; stroke-linecap: square"/> +" clip-path="url(#pc9f8534521)" style="fill: none; stroke: #000000; stroke-width: 2; stroke-linecap: square"/> +" clip-path="url(#pc9f8534521)" style="fill: #ffffff; stroke: #ffffff; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #33b1ff; stroke: #33b1ff; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> +" clip-path="url(#pc9f8534521)" style="fill: #9f1853; stroke: #9f1853; stroke-width: 1.5; stroke-linejoin: miter"/> - + @@ -184,7 +184,7 @@ z - + @@ -209,7 +209,7 @@ z - + @@ -244,7 +244,7 @@ z - + @@ -287,7 +287,7 @@ z - + @@ -295,7 +295,7 @@ z - + @@ -303,7 +303,7 @@ z - + @@ -364,7 +364,7 @@ z - + @@ -416,7 +416,7 @@ z - + @@ -426,7 +426,7 @@ z - + @@ -452,7 +452,7 @@ z - + @@ -460,7 +460,7 @@ z - + @@ -468,7 +468,7 @@ z - + @@ -553,7 +553,7 @@ z - + @@ -563,7 +563,7 @@ z - + @@ -587,7 +587,7 @@ z - + @@ -595,7 +595,7 @@ z - + @@ -603,7 +603,7 @@ z - + @@ -613,7 +613,7 @@ z - + @@ -623,7 +623,7 @@ z - + @@ -631,7 +631,7 @@ z - + @@ -639,7 +639,7 @@ z - + @@ -650,7 +650,7 @@ z - + @@ -660,7 +660,7 @@ z - + @@ -669,7 +669,7 @@ z - + @@ -677,7 +677,7 @@ z - + @@ -685,7 +685,7 @@ z - + @@ -695,7 +695,7 @@ z - + @@ -707,7 +707,7 @@ z - +