From 50e5954ecd4a729e7101e8ea4bf493240ae8b59e Mon Sep 17 00:00:00 2001 From: ElePT Date: Wed, 29 Mar 2023 12:18:03 +0200 Subject: [PATCH] Remove from docstring --- qiskit/opflow/converters/abelian_grouper.py | 2 +- qiskit/opflow/converters/circuit_sampler.py | 2 +- qiskit/opflow/converters/converter_base.py | 2 +- qiskit/opflow/converters/dict_to_circuit_sum.py | 2 +- qiskit/opflow/converters/pauli_basis_change.py | 2 +- qiskit/opflow/converters/two_qubit_reduction.py | 2 +- qiskit/opflow/evolutions/evolution_base.py | 2 +- qiskit/opflow/evolutions/evolution_factory.py | 2 +- qiskit/opflow/evolutions/evolved_op.py | 2 +- qiskit/opflow/evolutions/matrix_evolution.py | 2 +- qiskit/opflow/evolutions/pauli_trotter_evolution.py | 2 +- qiskit/opflow/evolutions/trotterizations/qdrift.py | 2 +- qiskit/opflow/evolutions/trotterizations/suzuki.py | 2 +- qiskit/opflow/evolutions/trotterizations/trotter.py | 2 +- .../evolutions/trotterizations/trotterization_base.py | 2 +- .../evolutions/trotterizations/trotterization_factory.py | 2 +- qiskit/opflow/exceptions.py | 2 +- qiskit/opflow/expectations/aer_pauli_expectation.py | 2 +- qiskit/opflow/expectations/cvar_expectation.py | 2 +- qiskit/opflow/expectations/expectation_base.py | 2 +- qiskit/opflow/expectations/expectation_factory.py | 2 +- qiskit/opflow/expectations/matrix_expectation.py | 2 +- qiskit/opflow/expectations/pauli_expectation.py | 2 +- .../opflow/gradients/circuit_gradients/circuit_gradient.py | 2 +- qiskit/opflow/gradients/circuit_gradients/lin_comb.py | 2 +- qiskit/opflow/gradients/circuit_gradients/param_shift.py | 2 +- qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py | 2 +- qiskit/opflow/gradients/circuit_qfis/lin_comb_full.py | 2 +- qiskit/opflow/gradients/circuit_qfis/overlap_block_diag.py | 2 +- qiskit/opflow/gradients/circuit_qfis/overlap_diag.py | 2 +- qiskit/opflow/gradients/derivative_base.py | 2 +- qiskit/opflow/gradients/gradient.py | 2 +- qiskit/opflow/gradients/gradient_base.py | 2 +- qiskit/opflow/gradients/hessian.py | 2 +- qiskit/opflow/gradients/hessian_base.py | 2 +- qiskit/opflow/gradients/natural_gradient.py | 2 +- qiskit/opflow/gradients/qfi.py | 2 +- qiskit/opflow/gradients/qfi_base.py | 2 +- qiskit/opflow/list_ops/composed_op.py | 2 +- qiskit/opflow/list_ops/list_op.py | 2 +- qiskit/opflow/list_ops/summed_op.py | 2 +- qiskit/opflow/list_ops/tensored_op.py | 2 +- qiskit/opflow/mixins/star_algebra.py | 2 +- qiskit/opflow/mixins/tensor.py | 2 +- qiskit/opflow/operator_base.py | 2 +- qiskit/opflow/primitive_ops/circuit_op.py | 2 +- qiskit/opflow/primitive_ops/matrix_op.py | 2 +- qiskit/opflow/primitive_ops/pauli_op.py | 2 +- qiskit/opflow/primitive_ops/pauli_sum_op.py | 2 +- qiskit/opflow/primitive_ops/primitive_op.py | 2 +- qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py | 2 +- qiskit/opflow/state_fns/circuit_state_fn.py | 2 +- qiskit/opflow/state_fns/cvar_measurement.py | 2 +- qiskit/opflow/state_fns/dict_state_fn.py | 2 +- qiskit/opflow/state_fns/operator_state_fn.py | 2 +- qiskit/opflow/state_fns/sparse_vector_state_fn.py | 2 +- qiskit/opflow/state_fns/state_fn.py | 2 +- qiskit/opflow/state_fns/vector_state_fn.py | 2 +- qiskit/opflow/utils.py | 6 +++--- 59 files changed, 61 insertions(+), 61 deletions(-) diff --git a/qiskit/opflow/converters/abelian_grouper.py b/qiskit/opflow/converters/abelian_grouper.py index 50cb4c954141..fb7cf5aeb5db 100644 --- a/qiskit/opflow/converters/abelian_grouper.py +++ b/qiskit/opflow/converters/abelian_grouper.py @@ -31,7 +31,7 @@ class AbelianGrouper(ConverterBase): - """Deprecation: The AbelianGrouper converts SummedOps into a sum of Abelian sums. + """The AbelianGrouper converts SummedOps into a sum of Abelian sums. Meaning, it will traverse the Operator, and when it finds a SummedOp, it will evaluate which of the summed sub-Operators commute with one another. It will then convert each of the groups of diff --git a/qiskit/opflow/converters/circuit_sampler.py b/qiskit/opflow/converters/circuit_sampler.py index 0e90c0c2263a..c3d6d96b4ab1 100644 --- a/qiskit/opflow/converters/circuit_sampler.py +++ b/qiskit/opflow/converters/circuit_sampler.py @@ -39,7 +39,7 @@ class CircuitSampler(ConverterBase): """ - Deprecation: The CircuitSampler traverses an Operator and converts any CircuitStateFns into + The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and diff --git a/qiskit/opflow/converters/converter_base.py b/qiskit/opflow/converters/converter_base.py index 4f503b83a8bd..9883eee01e47 100644 --- a/qiskit/opflow/converters/converter_base.py +++ b/qiskit/opflow/converters/converter_base.py @@ -19,7 +19,7 @@ class ConverterBase(ABC): r""" - Deprecation: Converters take an Operator and return a new Operator, generally isomorphic + Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. For example, a converter may accept ``CircuitOp`` and return a ``SummedOp`` of ``PauliOps`` representing the circuit unitary. Converters may not diff --git a/qiskit/opflow/converters/dict_to_circuit_sum.py b/qiskit/opflow/converters/dict_to_circuit_sum.py index d519ddbc843f..71689b3f2e44 100644 --- a/qiskit/opflow/converters/dict_to_circuit_sum.py +++ b/qiskit/opflow/converters/dict_to_circuit_sum.py @@ -22,7 +22,7 @@ class DictToCircuitSum(ConverterBase): r""" - Deprecation: Converts ``DictStateFns`` or ``VectorStateFns`` to equivalent ``CircuitStateFns`` + Converts ``DictStateFns`` or ``VectorStateFns`` to equivalent ``CircuitStateFns`` or sums thereof. The behavior of this class can be mostly replicated by calling ``to_circuit_op`` on an Operator, but with the added control of choosing whether to convert only ``DictStateFns`` or ``VectorStateFns``, rather than both. diff --git a/qiskit/opflow/converters/pauli_basis_change.py b/qiskit/opflow/converters/pauli_basis_change.py index 4c1120a92e2e..98462250b9ab 100644 --- a/qiskit/opflow/converters/pauli_basis_change.py +++ b/qiskit/opflow/converters/pauli_basis_change.py @@ -34,7 +34,7 @@ class PauliBasisChange(ConverterBase): r""" - Deprecation: Converter for changing Paulis into other bases. By default, the diagonal basis + Converter for changing Paulis into other bases. By default, the diagonal basis composed only of Pauli {Z, I}^n is used as the destination basis to which to convert. Meaning, if a Pauli containing X or Y terms is passed in, which cannot be sampled or evolved natively on some Quantum hardware, the Pauli can be replaced by a diff --git a/qiskit/opflow/converters/two_qubit_reduction.py b/qiskit/opflow/converters/two_qubit_reduction.py index aced893e2996..c1c1a19859fa 100644 --- a/qiskit/opflow/converters/two_qubit_reduction.py +++ b/qiskit/opflow/converters/two_qubit_reduction.py @@ -26,7 +26,7 @@ class TwoQubitReduction(ConverterBase): """ - Deprecation: Two qubit reduction converter which eliminates the central and last + Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. Chemistry specific method: diff --git a/qiskit/opflow/evolutions/evolution_base.py b/qiskit/opflow/evolutions/evolution_base.py index 8326bcefd4aa..afd7eff2f534 100644 --- a/qiskit/opflow/evolutions/evolution_base.py +++ b/qiskit/opflow/evolutions/evolution_base.py @@ -20,7 +20,7 @@ class EvolutionBase(ConverterBase, ABC): r""" - Deprecation: A base for Evolution converters. + A base for Evolution converters. Evolutions are converters which traverse an Operator tree, replacing any ``EvolvedOp`` `e` with a Schrodinger equation-style evolution ``CircuitOp`` equalling or approximating the matrix exponential of -i * the Operator contained inside (`e.primitive`). The Evolutions are diff --git a/qiskit/opflow/evolutions/evolution_factory.py b/qiskit/opflow/evolutions/evolution_factory.py index 8ae0919e3ec6..8c0e3db8f464 100644 --- a/qiskit/opflow/evolutions/evolution_factory.py +++ b/qiskit/opflow/evolutions/evolution_factory.py @@ -19,7 +19,7 @@ from qiskit.utils.deprecation import deprecate_func class EvolutionFactory: - """Deprecation: A factory class for convenient automatic selection of an + """A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. """ diff --git a/qiskit/opflow/evolutions/evolved_op.py b/qiskit/opflow/evolutions/evolved_op.py index bcdbd04b1bfa..e36b27fbd83c 100644 --- a/qiskit/opflow/evolutions/evolved_op.py +++ b/qiskit/opflow/evolutions/evolved_op.py @@ -31,7 +31,7 @@ class EvolvedOp(PrimitiveOp): r""" - Deprecation: Class for wrapping Operator Evolutions for compilation (``convert``) by an EvolutionBase + Class for wrapping Operator Evolutions for compilation (``convert``) by an EvolutionBase method later, essentially acting as a placeholder. Note that EvolvedOp is a weird case of PrimitiveOp. It happens to be that it fits into the PrimitiveOp interface nearly perfectly, and it essentially represents a placeholder for a PrimitiveOp later, even though it doesn't diff --git a/qiskit/opflow/evolutions/matrix_evolution.py b/qiskit/opflow/evolutions/matrix_evolution.py index fad0ae7123b4..d27b26dd538a 100644 --- a/qiskit/opflow/evolutions/matrix_evolution.py +++ b/qiskit/opflow/evolutions/matrix_evolution.py @@ -26,7 +26,7 @@ class MatrixEvolution(EvolutionBase): r""" - Deprecation: Performs Evolution by classical matrix exponentiation, constructing a circuit with + Performs Evolution by classical matrix exponentiation, constructing a circuit with ``UnitaryGates`` or ``HamiltonianGates`` containing the exponentiation of the Operator. """ diff --git a/qiskit/opflow/evolutions/pauli_trotter_evolution.py b/qiskit/opflow/evolutions/pauli_trotter_evolution.py index 6901a7cbab0e..37ddf4ebe84e 100644 --- a/qiskit/opflow/evolutions/pauli_trotter_evolution.py +++ b/qiskit/opflow/evolutions/pauli_trotter_evolution.py @@ -41,7 +41,7 @@ class PauliTrotterEvolution(EvolutionBase): r""" - Deprecation: An Evolution algorithm replacing exponentiated sums of Paulis by changing + An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. More specifically, we compute basis change circuits for each Pauli into a single-qubit Z, diff --git a/qiskit/opflow/evolutions/trotterizations/qdrift.py b/qiskit/opflow/evolutions/trotterizations/qdrift.py index 46cca0c99193..6a01196c6149 100644 --- a/qiskit/opflow/evolutions/trotterizations/qdrift.py +++ b/qiskit/opflow/evolutions/trotterizations/qdrift.py @@ -31,7 +31,7 @@ class QDrift(TrotterizationBase): - """Deprecation: The QDrift Trotterization method, which selects each each term in the + """The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. Based on the work of Earl Campbell in https://arxiv.org/abs/1811.08017. """ diff --git a/qiskit/opflow/evolutions/trotterizations/suzuki.py b/qiskit/opflow/evolutions/trotterizations/suzuki.py index 1e37e3ce96fa..d959f142149c 100644 --- a/qiskit/opflow/evolutions/trotterizations/suzuki.py +++ b/qiskit/opflow/evolutions/trotterizations/suzuki.py @@ -27,7 +27,7 @@ class Suzuki(TrotterizationBase): r""" - Deprecation: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum + Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit ``reps`` times. diff --git a/qiskit/opflow/evolutions/trotterizations/trotter.py b/qiskit/opflow/evolutions/trotterizations/trotter.py index f101adb5b12b..ba28adfc24db 100644 --- a/qiskit/opflow/evolutions/trotterizations/trotter.py +++ b/qiskit/opflow/evolutions/trotterizations/trotter.py @@ -17,7 +17,7 @@ class Trotter(Suzuki): r""" - Deprecation: Simple Trotter expansion, composing the evolution circuits of each Operator in the sum + Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together ``reps`` times and dividing the evolution time of each by ``reps``. """ diff --git a/qiskit/opflow/evolutions/trotterizations/trotterization_base.py b/qiskit/opflow/evolutions/trotterizations/trotterization_base.py index e9409cd9e112..5270c5063548 100644 --- a/qiskit/opflow/evolutions/trotterizations/trotterization_base.py +++ b/qiskit/opflow/evolutions/trotterizations/trotterization_base.py @@ -21,7 +21,7 @@ class TrotterizationBase(EvolutionBase): - """Deprecation: A base for Trotterization methods, algorithms for approximating exponentiations of + """A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. """ diff --git a/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py b/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py index b926ea1f9c24..81907c3c1a29 100644 --- a/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py +++ b/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py @@ -19,7 +19,7 @@ from qiskit.utils.deprecation import deprecate_func class TrotterizationFactory: - """Deprecation: A factory for conveniently creating TrotterizationBase instances.""" + """A factory for conveniently creating TrotterizationBase instances.""" @staticmethod @deprecate_func( diff --git a/qiskit/opflow/exceptions.py b/qiskit/opflow/exceptions.py index 3950e5bedc95..f7f30d1b4f84 100644 --- a/qiskit/opflow/exceptions.py +++ b/qiskit/opflow/exceptions.py @@ -17,7 +17,7 @@ class OpflowError(QiskitError): - """Deprecation: For Opflow specific errors.""" + """For Opflow specific errors.""" @deprecate_func( since="0.24.0", diff --git a/qiskit/opflow/expectations/aer_pauli_expectation.py b/qiskit/opflow/expectations/aer_pauli_expectation.py index ca7829fcd19e..b1e49516a5f7 100644 --- a/qiskit/opflow/expectations/aer_pauli_expectation.py +++ b/qiskit/opflow/expectations/aer_pauli_expectation.py @@ -33,7 +33,7 @@ class AerPauliExpectation(ExpectationBase): - r"""Deprecation: An Expectation converter for using Aer's operator snapshot to + r"""An Expectation converter for using Aer's operator snapshot to take expectations of quantum state circuits over Pauli observables. """ diff --git a/qiskit/opflow/expectations/cvar_expectation.py b/qiskit/opflow/expectations/cvar_expectation.py index d55dbdc243b1..14d427dacf0d 100644 --- a/qiskit/opflow/expectations/cvar_expectation.py +++ b/qiskit/opflow/expectations/cvar_expectation.py @@ -23,7 +23,7 @@ from qiskit.utils.deprecation import deprecate_func class CVaRExpectation(ExpectationBase): - r"""Deprecation: Compute the Conditional Value at Risk (CVaR) expectation value. + r"""Compute the Conditional Value at Risk (CVaR) expectation value. The standard approach to calculating the expectation value of a Hamiltonian w.r.t. a state is to take the sample mean of the measurement outcomes. This corresponds to an estimator diff --git a/qiskit/opflow/expectations/expectation_base.py b/qiskit/opflow/expectations/expectation_base.py index 678dc7697a74..585b89b5ce73 100644 --- a/qiskit/opflow/expectations/expectation_base.py +++ b/qiskit/opflow/expectations/expectation_base.py @@ -23,7 +23,7 @@ class ExpectationBase(ConverterBase): r""" - Deprecation: A base for Expectation value converters. Expectations are converters which enable the + A base for Expectation value converters. Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing OperatorStateFn measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For diff --git a/qiskit/opflow/expectations/expectation_factory.py b/qiskit/opflow/expectations/expectation_factory.py index 8059e638da46..dfcb1fc25304 100644 --- a/qiskit/opflow/expectations/expectation_factory.py +++ b/qiskit/opflow/expectations/expectation_factory.py @@ -30,7 +30,7 @@ class ExpectationFactory: - """Deprecation: factory class for convenient automatic selection of an Expectation based on the + """ factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. """ diff --git a/qiskit/opflow/expectations/matrix_expectation.py b/qiskit/opflow/expectations/matrix_expectation.py index 23dc72eb6b77..ca4ab485f840 100644 --- a/qiskit/opflow/expectations/matrix_expectation.py +++ b/qiskit/opflow/expectations/matrix_expectation.py @@ -21,7 +21,7 @@ from qiskit.utils.deprecation import deprecate_func class MatrixExpectation(ExpectationBase): - """Deprecation: An Expectation converter which converts Operator measurements to + """An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication.""" @deprecate_func( diff --git a/qiskit/opflow/expectations/pauli_expectation.py b/qiskit/opflow/expectations/pauli_expectation.py index 4c3793e864e5..c9558bc72317 100644 --- a/qiskit/opflow/expectations/pauli_expectation.py +++ b/qiskit/opflow/expectations/pauli_expectation.py @@ -33,7 +33,7 @@ class PauliExpectation(ExpectationBase): r""" - Deprecation: An Expectation converter for Pauli-basis observables by changing Pauli measurements to a + An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal ({Z, I}^n) basis and appending circuit post-rotations to the measured state function. Optionally groups the Paulis with the same post-rotations (those that commute with one another, or form Abelian groups) into single measurements to reduce circuit execution diff --git a/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py b/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py index 4e109096859a..d6b5aae0cbd1 100644 --- a/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py +++ b/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py @@ -23,7 +23,7 @@ class CircuitGradient(ConverterBase): - r"""Deprecation: Circuit to gradient operator converter. + r"""Circuit to gradient operator converter. Converter for changing parameterized circuits into operators whose evaluation yields the gradient with respect to the circuit parameters. diff --git a/qiskit/opflow/gradients/circuit_gradients/lin_comb.py b/qiskit/opflow/gradients/circuit_gradients/lin_comb.py index 6d7db18b531c..49065312d86c 100644 --- a/qiskit/opflow/gradients/circuit_gradients/lin_comb.py +++ b/qiskit/opflow/gradients/circuit_gradients/lin_comb.py @@ -68,7 +68,7 @@ class LinComb(CircuitGradient): - """Deprecation: Compute the state gradient d⟨ψ(ω)|O(θ)|ψ(ω)〉/ dω respectively the gradients of the + """Compute the state gradient d⟨ψ(ω)|O(θ)|ψ(ω)〉/ dω respectively the gradients of the sampling probabilities of the basis states of a state |ψ(ω)〉w.r.t. ω. This method employs a linear combination of unitaries, diff --git a/qiskit/opflow/gradients/circuit_gradients/param_shift.py b/qiskit/opflow/gradients/circuit_gradients/param_shift.py index d7105041444e..bfe6f1ebcf42 100644 --- a/qiskit/opflow/gradients/circuit_gradients/param_shift.py +++ b/qiskit/opflow/gradients/circuit_gradients/param_shift.py @@ -40,7 +40,7 @@ class ParamShift(CircuitGradient): - """Deprecation: Compute the gradient d⟨ψ(ω)|O(θ)|ψ(ω)〉/ dω respectively the gradients of the sampling + """Compute the gradient d⟨ψ(ω)|O(θ)|ψ(ω)〉/ dω respectively the gradients of the sampling probabilities of the basis states of a state |ψ(ω)〉w.r.t. ω with the parameter shift method. """ diff --git a/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py b/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py index 61875f8c8020..0a48236a26cc 100644 --- a/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py +++ b/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py @@ -22,7 +22,7 @@ class CircuitQFI(ConverterBase): - r"""Deprecation: Circuit to Quantum Fisher Information operator converter. + r"""Circuit to Quantum Fisher Information operator converter. Converter for changing parameterized circuits into operators whose evaluation yields Quantum Fisher Information metric tensor diff --git a/qiskit/opflow/gradients/circuit_qfis/lin_comb_full.py b/qiskit/opflow/gradients/circuit_qfis/lin_comb_full.py index 48d548f34e35..069aa5275cf2 100644 --- a/qiskit/opflow/gradients/circuit_qfis/lin_comb_full.py +++ b/qiskit/opflow/gradients/circuit_qfis/lin_comb_full.py @@ -29,7 +29,7 @@ class LinCombFull(CircuitQFI): - r"""Deprecation: Compute the full Quantum Fisher Information (QFI). + r"""Compute the full Quantum Fisher Information (QFI). Given a pure, parameterized quantum state this class uses the linear combination of unitaries See also :class:`~qiskit.opflow.QFI`. diff --git a/qiskit/opflow/gradients/circuit_qfis/overlap_block_diag.py b/qiskit/opflow/gradients/circuit_qfis/overlap_block_diag.py index 81a871904fde..c4d76894cf50 100644 --- a/qiskit/opflow/gradients/circuit_qfis/overlap_block_diag.py +++ b/qiskit/opflow/gradients/circuit_qfis/overlap_block_diag.py @@ -33,7 +33,7 @@ class OverlapBlockDiag(CircuitQFI): - r"""Deprecation: Compute the block-diagonal of the QFI given a pure, parameterized quantum state. + r"""Compute the block-diagonal of the QFI given a pure, parameterized quantum state. The blocks are given by all parameterized gates in quantum circuit layer. See also :class:`~qiskit.opflow.QFI`. diff --git a/qiskit/opflow/gradients/circuit_qfis/overlap_diag.py b/qiskit/opflow/gradients/circuit_qfis/overlap_diag.py index fc85ac3f4b67..45be6670c220 100644 --- a/qiskit/opflow/gradients/circuit_qfis/overlap_diag.py +++ b/qiskit/opflow/gradients/circuit_qfis/overlap_diag.py @@ -33,7 +33,7 @@ class OverlapDiag(CircuitQFI): - r"""Deprecation: Compute the diagonal of the QFI given a pure, parameterized quantum state. + r"""Compute the diagonal of the QFI given a pure, parameterized quantum state. See also :class:`~qiskit.opflow.QFI`. """ diff --git a/qiskit/opflow/gradients/derivative_base.py b/qiskit/opflow/gradients/derivative_base.py index dfadcf2db002..46f1d97406a8 100644 --- a/qiskit/opflow/gradients/derivative_base.py +++ b/qiskit/opflow/gradients/derivative_base.py @@ -34,7 +34,7 @@ class DerivativeBase(ConverterBase): - r"""Deprecation: Base class for differentiating opflow objects. + r"""Base class for differentiating opflow objects. Converter for differentiating opflow objects and handling things like properly differentiating combo_fn's and enforcing product rules diff --git a/qiskit/opflow/gradients/gradient.py b/qiskit/opflow/gradients/gradient.py index de3948bc2280..52fb3166f832 100644 --- a/qiskit/opflow/gradients/gradient.py +++ b/qiskit/opflow/gradients/gradient.py @@ -35,7 +35,7 @@ class Gradient(GradientBase): - """Deprecation: Convert an operator expression to the first-order gradient.""" + """Convert an operator expression to the first-order gradient.""" @deprecate_func( since="0.24.0", diff --git a/qiskit/opflow/gradients/gradient_base.py b/qiskit/opflow/gradients/gradient_base.py index 8618023e25c6..6775daaffeac 100644 --- a/qiskit/opflow/gradients/gradient_base.py +++ b/qiskit/opflow/gradients/gradient_base.py @@ -20,7 +20,7 @@ class GradientBase(DerivativeBase): - """Deprecation: Base class for first-order operator gradient. + """Base class for first-order operator gradient. Convert an operator expression to the first-order gradient. """ diff --git a/qiskit/opflow/gradients/hessian.py b/qiskit/opflow/gradients/hessian.py index e71412e38f38..50a0e3a47af2 100644 --- a/qiskit/opflow/gradients/hessian.py +++ b/qiskit/opflow/gradients/hessian.py @@ -38,7 +38,7 @@ class Hessian(HessianBase): - """Deprecation: Compute the Hessian of an expected value.""" + """Compute the Hessian of an expected value.""" @deprecate_func( since="0.24.0", diff --git a/qiskit/opflow/gradients/hessian_base.py b/qiskit/opflow/gradients/hessian_base.py index ea3e8aa0550f..02a209137613 100644 --- a/qiskit/opflow/gradients/hessian_base.py +++ b/qiskit/opflow/gradients/hessian_base.py @@ -20,7 +20,7 @@ class HessianBase(DerivativeBase): - """Deprecation: Base class for the Hessian of an expected value.""" + """Base class for the Hessian of an expected value.""" @deprecate_func( since="0.24.0", diff --git a/qiskit/opflow/gradients/natural_gradient.py b/qiskit/opflow/gradients/natural_gradient.py index a0e703f016ff..e8159f8ed568 100644 --- a/qiskit/opflow/gradients/natural_gradient.py +++ b/qiskit/opflow/gradients/natural_gradient.py @@ -38,7 +38,7 @@ class NaturalGradient(GradientBase): - r"""Deprecation: Convert an operator expression to the first-order gradient. + r"""Convert an operator expression to the first-order gradient. Given an ill-posed inverse problem diff --git a/qiskit/opflow/gradients/qfi.py b/qiskit/opflow/gradients/qfi.py index 56ad342e32de..75f1cdbaa621 100644 --- a/qiskit/opflow/gradients/qfi.py +++ b/qiskit/opflow/gradients/qfi.py @@ -26,7 +26,7 @@ class QFI(QFIBase): - r"""Deprecation: Compute the Quantum Fisher Information (QFI). + r"""Compute the Quantum Fisher Information (QFI). Computes the QFI given a pure, parameterized quantum state, where QFI is: diff --git a/qiskit/opflow/gradients/qfi_base.py b/qiskit/opflow/gradients/qfi_base.py index deb2e722a6fe..55500b87276e 100644 --- a/qiskit/opflow/gradients/qfi_base.py +++ b/qiskit/opflow/gradients/qfi_base.py @@ -21,7 +21,7 @@ class QFIBase(DerivativeBase): - r"""Deprecation: Base class for Quantum Fisher Information (QFI). + r"""Base class for Quantum Fisher Information (QFI). Compute the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. diff --git a/qiskit/opflow/list_ops/composed_op.py b/qiskit/opflow/list_ops/composed_op.py index 89fe194f5270..b25a37e36930 100644 --- a/qiskit/opflow/list_ops/composed_op.py +++ b/qiskit/opflow/list_ops/composed_op.py @@ -28,7 +28,7 @@ class ComposedOp(ListOp): - """Deprecation: A class for lazily representing compositions of Operators. Often Operators cannot be + """A class for lazily representing compositions of Operators. Often Operators cannot be efficiently composed with one another, but may be manipulated further so that they can be composed later. This class holds logic to indicate that the Operators in ``oplist`` are meant to be composed, and therefore if they reach a point in which they can be, such as after diff --git a/qiskit/opflow/list_ops/list_op.py b/qiskit/opflow/list_ops/list_op.py index ae95a3972d3b..49d5ae47ea78 100644 --- a/qiskit/opflow/list_ops/list_op.py +++ b/qiskit/opflow/list_ops/list_op.py @@ -28,7 +28,7 @@ class ListOp(OperatorBase): """ - Deprecation: A Class for manipulating List Operators, and parent class to ``SummedOp``, + A Class for manipulating List Operators, and parent class to ``SummedOp``, ``ComposedOp`` and ``TensoredOp``. List Operators are classes for storing and manipulating lists of Operators, State functions, diff --git a/qiskit/opflow/list_ops/summed_op.py b/qiskit/opflow/list_ops/summed_op.py index a0191f2b5e2d..acf3298ff564 100644 --- a/qiskit/opflow/list_ops/summed_op.py +++ b/qiskit/opflow/list_ops/summed_op.py @@ -25,7 +25,7 @@ class SummedOp(ListOp): - """Deprecation: A class for lazily representing sums of Operators. Often Operators cannot be + """A class for lazily representing sums of Operators. Often Operators cannot be efficiently added to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in ``oplist`` are meant to be added together, and therefore if they reach a point in which they can be, such as after diff --git a/qiskit/opflow/list_ops/tensored_op.py b/qiskit/opflow/list_ops/tensored_op.py index efe7e0685c9b..6aa72d1b9ff3 100644 --- a/qiskit/opflow/list_ops/tensored_op.py +++ b/qiskit/opflow/list_ops/tensored_op.py @@ -26,7 +26,7 @@ class TensoredOp(ListOp): - """Deprecation: A class for lazily representing tensor products of Operators. Often Operators + """A class for lazily representing tensor products of Operators. Often Operators cannot be efficiently tensored to one another, but may be manipulated further so that they can be later. This class holds logic to indicate that the Operators in ``oplist`` are meant to be tensored together, and therefore if they reach a point in which they can be, such as after diff --git a/qiskit/opflow/mixins/star_algebra.py b/qiskit/opflow/mixins/star_algebra.py index b4a7e5c142c9..08352272ec9c 100644 --- a/qiskit/opflow/mixins/star_algebra.py +++ b/qiskit/opflow/mixins/star_algebra.py @@ -20,7 +20,7 @@ class StarAlgebraMixin(MultiplyMixin, ABC): - """Deprecation: The star algebra mixin class. + """The star algebra mixin class. Star algebra is an algebra with an adjoint. This class overrides: diff --git a/qiskit/opflow/mixins/tensor.py b/qiskit/opflow/mixins/tensor.py index 5c8fd5c75078..6b6a56bcf183 100644 --- a/qiskit/opflow/mixins/tensor.py +++ b/qiskit/opflow/mixins/tensor.py @@ -18,7 +18,7 @@ class TensorMixin(ABC): - """Deprecation: The mixin class for tensor operations. + """The mixin class for tensor operations. This class overrides: - ``^``, ``__xor__``, `__rxor__` -> :meth:`tensor` between two operators and diff --git a/qiskit/opflow/operator_base.py b/qiskit/opflow/operator_base.py index f2c94d4db04f..37c384bdbae5 100644 --- a/qiskit/opflow/operator_base.py +++ b/qiskit/opflow/operator_base.py @@ -29,7 +29,7 @@ class OperatorBase(StarAlgebraMixin, TensorMixin, ABC): - """Deprecation: A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are + """A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. Operators are defined as functions which take one complex binary function to another. These complex binary functions are represented by StateFns, which are themselves a special class of Operators taking only the ``Zero`` StateFn to the complex binary function they represent. diff --git a/qiskit/opflow/primitive_ops/circuit_op.py b/qiskit/opflow/primitive_ops/circuit_op.py index 69209689fe11..86ed5448d560 100644 --- a/qiskit/opflow/primitive_ops/circuit_op.py +++ b/qiskit/opflow/primitive_ops/circuit_op.py @@ -27,7 +27,7 @@ class CircuitOp(PrimitiveOp): - """Deprecation: Class for Operators backed by Terra's ``QuantumCircuit`` module.""" + """Class for Operators backed by Terra's ``QuantumCircuit`` module.""" primitive: QuantumCircuit diff --git a/qiskit/opflow/primitive_ops/matrix_op.py b/qiskit/opflow/primitive_ops/matrix_op.py index 752d61d6d3f8..fc4ab49dd1d6 100644 --- a/qiskit/opflow/primitive_ops/matrix_op.py +++ b/qiskit/opflow/primitive_ops/matrix_op.py @@ -31,7 +31,7 @@ class MatrixOp(PrimitiveOp): - """Deprecation: Class for Operators represented by matrices, + """Class for Operators represented by matrices, backed by Terra's ``Operator`` module.""" primitive: Operator diff --git a/qiskit/opflow/primitive_ops/pauli_op.py b/qiskit/opflow/primitive_ops/pauli_op.py index 3a0c1440ad75..bf8fe3ddb5e1 100644 --- a/qiskit/opflow/primitive_ops/pauli_op.py +++ b/qiskit/opflow/primitive_ops/pauli_op.py @@ -31,7 +31,7 @@ class PauliOp(PrimitiveOp): - """Deprecation: Class for Operators backed by Terra's ``Pauli`` module.""" + """Class for Operators backed by Terra's ``Pauli`` module.""" primitive: Pauli diff --git a/qiskit/opflow/primitive_ops/pauli_sum_op.py b/qiskit/opflow/primitive_ops/pauli_sum_op.py index 3578382aef72..08f928ec6631 100644 --- a/qiskit/opflow/primitive_ops/pauli_sum_op.py +++ b/qiskit/opflow/primitive_ops/pauli_sum_op.py @@ -30,7 +30,7 @@ class PauliSumOp(PrimitiveOp): - """Deprecation: Class for Operators backed by Terra's ``SparsePauliOp`` class.""" + """Class for Operators backed by Terra's ``SparsePauliOp`` class.""" primitive: SparsePauliOp diff --git a/qiskit/opflow/primitive_ops/primitive_op.py b/qiskit/opflow/primitive_ops/primitive_op.py index 2277dc6d2ff9..d2f067474da3 100644 --- a/qiskit/opflow/primitive_ops/primitive_op.py +++ b/qiskit/opflow/primitive_ops/primitive_op.py @@ -27,7 +27,7 @@ class PrimitiveOp(OperatorBase): r""" - Deprecation: A class for representing basic Operators, backed by Operator primitives from + A class for representing basic Operators, backed by Operator primitives from Terra. This class (and inheritors) primarily serves to allow the underlying primitives to "flow" - i.e. interoperability and adherence to the Operator formalism - while the core computational logic mostly remains in the underlying primitives. diff --git a/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py b/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py index c3183cff2b3f..ba7711217398 100644 --- a/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py +++ b/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py @@ -33,7 +33,7 @@ class TaperedPauliSumOp(PauliSumOp): - """Deprecation: Class for PauliSumOp after tapering""" + """Class for PauliSumOp after tapering""" @deprecate_func( since="0.24.0", diff --git a/qiskit/opflow/state_fns/circuit_state_fn.py b/qiskit/opflow/state_fns/circuit_state_fn.py index ac5e8fd7b7d7..4477edd7795c 100644 --- a/qiskit/opflow/state_fns/circuit_state_fn.py +++ b/qiskit/opflow/state_fns/circuit_state_fn.py @@ -37,7 +37,7 @@ class CircuitStateFn(StateFn): r""" - Deprecation: A class for state functions and measurements which are defined by the action of a + A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from \|0⟩, and stored using Terra's ``QuantumCircuit`` class. """ primitive: QuantumCircuit diff --git a/qiskit/opflow/state_fns/cvar_measurement.py b/qiskit/opflow/state_fns/cvar_measurement.py index 236cbfe0c9be..84df068d3f5f 100644 --- a/qiskit/opflow/state_fns/cvar_measurement.py +++ b/qiskit/opflow/state_fns/cvar_measurement.py @@ -31,7 +31,7 @@ from qiskit.utils.deprecation import deprecate_func class CVaRMeasurement(OperatorStateFn): - r"""Deprecation: A specialized measurement class to compute CVaR expectation values. + r"""A specialized measurement class to compute CVaR expectation values. See https://arxiv.org/pdf/1907.04769.pdf for further details. Used in :class:`~qiskit.opflow.CVaRExpectation`, see there for more details. diff --git a/qiskit/opflow/state_fns/dict_state_fn.py b/qiskit/opflow/state_fns/dict_state_fn.py index 7b574645641a..9ad2929f914a 100644 --- a/qiskit/opflow/state_fns/dict_state_fn.py +++ b/qiskit/opflow/state_fns/dict_state_fn.py @@ -30,7 +30,7 @@ from qiskit.utils.deprecation import deprecate_func class DictStateFn(StateFn): - """Deprecation: A class for state functions and measurements which are defined by a lookup table, + """A class for state functions and measurements which are defined by a lookup table, stored in a dict. """ diff --git a/qiskit/opflow/state_fns/operator_state_fn.py b/qiskit/opflow/state_fns/operator_state_fn.py index dead517be5dd..bf4a5c88b3ec 100644 --- a/qiskit/opflow/state_fns/operator_state_fn.py +++ b/qiskit/opflow/state_fns/operator_state_fn.py @@ -30,7 +30,7 @@ class OperatorStateFn(StateFn): r""" - Deprecation: A class for state functions and measurements which are defined by a density Operator, + A class for state functions and measurements which are defined by a density Operator, stored using an ``OperatorBase``. """ primitive: OperatorBase diff --git a/qiskit/opflow/state_fns/sparse_vector_state_fn.py b/qiskit/opflow/state_fns/sparse_vector_state_fn.py index d5a4f28c4bb4..f67aca5b600f 100644 --- a/qiskit/opflow/state_fns/sparse_vector_state_fn.py +++ b/qiskit/opflow/state_fns/sparse_vector_state_fn.py @@ -29,7 +29,7 @@ from qiskit.utils.deprecation import deprecate_func class SparseVectorStateFn(StateFn): - """Deprecation: A class for sparse state functions and measurements in vector representation. + """A class for sparse state functions and measurements in vector representation. This class uses ``scipy.sparse.spmatrix`` for the internal representation. """ diff --git a/qiskit/opflow/state_fns/state_fn.py b/qiskit/opflow/state_fns/state_fn.py index 06ec935375f6..7fe009f59fbe 100644 --- a/qiskit/opflow/state_fns/state_fn.py +++ b/qiskit/opflow/state_fns/state_fn.py @@ -26,7 +26,7 @@ class StateFn(OperatorBase): r""" - Deprecation: A class for representing state functions and measurements. + A class for representing state functions and measurements. State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a diff --git a/qiskit/opflow/state_fns/vector_state_fn.py b/qiskit/opflow/state_fns/vector_state_fn.py index 2e3936aa2257..a92a14fb6ad6 100644 --- a/qiskit/opflow/state_fns/vector_state_fn.py +++ b/qiskit/opflow/state_fns/vector_state_fn.py @@ -29,7 +29,7 @@ from qiskit.utils.deprecation import deprecate_func class VectorStateFn(StateFn): - """Deprecation: A class for state functions and measurements which are defined in vector + """A class for state functions and measurements which are defined in vector representation, and stored using Terra's ``Statevector`` class. """ diff --git a/qiskit/opflow/utils.py b/qiskit/opflow/utils.py index 6010890b0b8c..f76c04c204a0 100644 --- a/qiskit/opflow/utils.py +++ b/qiskit/opflow/utils.py @@ -22,7 +22,7 @@ ) def commutator(op_a: OperatorBase, op_b: OperatorBase) -> OperatorBase: r""" - Deprecation: Compute commutator of `op_a` and `op_b`. + Compute commutator of `op_a` and `op_b`. .. math:: @@ -43,7 +43,7 @@ def commutator(op_a: OperatorBase, op_b: OperatorBase) -> OperatorBase: ) def anti_commutator(op_a: OperatorBase, op_b: OperatorBase) -> OperatorBase: r""" - Deprecation: Compute anti-commutator of `op_a` and `op_b`. + Compute anti-commutator of `op_a` and `op_b`. .. math:: @@ -69,7 +69,7 @@ def double_commutator( sign: bool = False, ) -> OperatorBase: r""" - Deprecation: Compute symmetric double commutator of `op_a`, `op_b` and `op_c`. + Compute symmetric double commutator of `op_a`, `op_b` and `op_c`. See McWeeny chapter 13.6 Equation of motion methods (page 479) If `sign` is `False`, it returns