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

Update documentation to remove pennylane.optimize #5810

Open
CatalinaAlbornoz opened this issue Jun 6, 2024 · 3 comments
Open

Update documentation to remove pennylane.optimize #5810

CatalinaAlbornoz opened this issue Jun 6, 2024 · 3 comments
Labels
enhancement ✨ New feature or request

Comments

@CatalinaAlbornoz
Copy link
Contributor

Feature details

Remove the mention to pennylane.optimize in the documentation since it no longer exists. Eg remove it from here.

Implementation

No response

How important would you say this feature is?

1: Not important. Would be nice to have.

Additional information

No response

@CatalinaAlbornoz CatalinaAlbornoz added the enhancement ✨ New feature or request label Jun 6, 2024
@CatalinaAlbornoz CatalinaAlbornoz changed the title Update documentation Update documentation to remove pennylane.optimize Jun 6, 2024
@albi3ro
Copy link
Contributor

albi3ro commented Jun 6, 2024

Should we instead add module documentation for the optimize module?

@trbromley
Copy link
Contributor

I'm not sure why we decided not to add pennylane.optimize module documentation in the first place.

But looking at the description here, I'm not sure what more we'd add. So maybe it's enough to just edit the line on that page: "For more details on the NumPy optimizers, check out the tutorials, as well as the pennylane.optimize documentation".

@josh146
Copy link
Member

josh146 commented Jun 10, 2024

We opted to remove pennylane.optimize since everything in it lives top level, and it was causing confusion to Sphinx and readers to have the same function live in two places.

The same reason why we don't have module docs for qml.ops.

Rather than add it back in, I would take this as a datapoint we should make the optimization quickstart clearer and easier to find

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ✨ New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants