Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Remove redundant information in evolve() documentation #5347

Merged
merged 7 commits into from
Mar 12, 2024
3 changes: 3 additions & 0 deletions doc/releases/changelog-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@

<h3>Documentation 📝</h3>

* Removed some redundant documentation for the `evolve` function.
[(#5347)](https://github.com/PennyLaneAI/pennylane/pull/5347)

* Updated the final example in the `compile` docstring to use transforms correctly.
[(#5348)](https://github.com/PennyLaneAI/pennylane/pull/5348)

Expand Down
10 changes: 0 additions & 10 deletions pennylane/ops/functions/evolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,6 @@ def evolve(*args, **kwargs): # pylint: disable=unused-argument
Returns:
.Evolution: evolution operator

.. seealso::

:class:`~.Evolution`

**Examples**

We can use ``qml.evolve`` to compute the evolution of any PennyLane operator:
Expand Down Expand Up @@ -83,10 +79,6 @@ def evolve(*args, **kwargs): # pylint: disable=unused-argument
The :class:`~.ParametrizedEvolution` class uses a numerical ordinary differential equation
solver (`here <https://github.com/google/jax/blob/main/jax/experimental/ode.py>`_).

.. seealso::

:class:`~.ParametrizedEvolution`

**Examples**

When evolving a :class:`.ParametrizedHamiltonian`, a :class:`.ParametrizedEvolution`
Expand Down Expand Up @@ -159,8 +151,6 @@ def circuit(params):
the first execution will typically take a little longer with the benefit that all following executions
will be significantly faster, see the jax docs on jitting. JIT-compiling is optional, and one can remove
the decorator when only single executions are of interest.

Please check the :class:`.ParametrizedEvolution` class for more usage details.
"""


Expand Down
Loading