Skip to content

Commit

Permalink
Remove from docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ElePT committed Mar 29, 2023
1 parent 15fce2b commit 50e5954
Show file tree
Hide file tree
Showing 59 changed files with 61 additions and 61 deletions.
2 changes: 1 addition & 1 deletion qiskit/opflow/converters/abelian_grouper.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/converters/circuit_sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/converters/converter_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/converters/dict_to_circuit_sum.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/converters/pauli_basis_change.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/converters/two_qubit_reduction.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/evolution_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/evolution_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/evolved_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/matrix_evolution.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/pauli_trotter_evolution.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/trotterizations/qdrift.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/trotterizations/suzuki.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/evolutions/trotterizations/trotter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@


class OpflowError(QiskitError):
"""Deprecation: For Opflow specific errors."""
"""For Opflow specific errors."""

@deprecate_func(
since="0.24.0",
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/expectations/aer_pauli_expectation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/expectations/cvar_expectation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/expectations/expectation_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/expectations/expectation_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/expectations/matrix_expectation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/expectations/pauli_expectation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/circuit_gradients/lin_comb.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/circuit_gradients/param_shift.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/circuit_qfis/lin_comb_full.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/circuit_qfis/overlap_block_diag.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/circuit_qfis/overlap_diag.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
"""
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/derivative_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/gradient.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/gradient_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/hessian.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/hessian_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/natural_gradient.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/qfi.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/gradients/qfi_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/list_ops/composed_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/list_ops/list_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/list_ops/summed_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/list_ops/tensored_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/mixins/star_algebra.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion qiskit/opflow/mixins/tensor.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 50e5954

Please sign in to comment.