Giter VIP home page Giter VIP logo

Comments (3)

albi3ro avatar albi3ro commented on June 24, 2024

Should we instead add module documentation for the optimize module?

from pennylane.

trbromley avatar trbromley commented on June 24, 2024

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".

from pennylane.

josh146 avatar josh146 commented on June 24, 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

from pennylane.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.