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

jax interface missing from QNode documentation #1729

Closed
albi3ro opened this issue Oct 8, 2021 · 5 comments
Closed

jax interface missing from QNode documentation #1729

albi3ro opened this issue Oct 8, 2021 · 5 comments
Labels
documentation 📘 Documentation changes and updates good first issue Good for newcomers Hacktoberfest Participating in Hacktoberfest event

Comments

@albi3ro
Copy link
Contributor

albi3ro commented Oct 8, 2021

In the information about interfaces in the QNode documentation, the "jax" option is missing, even though the QNode can have a jax interface.

We need to have a bullet point for the "jax" option.

@albi3ro albi3ro added documentation 📘 Documentation changes and updates Hacktoberfest Participating in Hacktoberfest event good first issue Good for newcomers labels Oct 8, 2021
@anonymousr007
Copy link
Contributor

Hi @albi3ro, Can you please elaborate ?

@Jaybsoni
Copy link
Contributor

Hi @anonymousr007, I think what @albi3ro is referring to is the documentation for the QNode class (here). Under the parameters section, there is a parameter called interface. There are 4 options listed for this parameter ('autograd', 'torch', 'tf', None).

It turns out that the QNode also supports the jax interface (label: "jax"). To solve this issue you would have to go into the file qnode.py and update the documentation by adding a bullet point for "jax" followed by a brief description!

This is a great first issue for those who are just starting to learn about quantum computing as it lets you dig into the documentation behind one of the core objects in Pennylane. Also it is a fairly easy contribution to earn a free t-shirt as part of Hacktoberfest! Let us know if you would like to tackle this problem and we encourage you to make a work in progress [WIP] pr so that we can follow along with your progress.

All the best,

@anonymousr007
Copy link
Contributor

anonymousr007 commented Oct 14, 2021

Yes, I want to tackle this problem.

  • "jax": Allows JAX to backpropogate
    through the QNode. The QNode accepts and returns a single expectation value or variance

Can we make a pull request ?

@Jaybsoni
Copy link
Contributor

@anonymousr007 yes for sure! If you could also link it here that would be great!

@anonymousr007
Copy link
Contributor

PR #1755

Jaybsoni added a commit that referenced this issue Oct 15, 2021
* Update qnode.py

* Update qnode.py

* Update qnode.py

* Update pennylane/qnode.py

* Update qnode.py

* Update changelog-dev.md

* Update changelog-dev.md

Co-authored-by: Jay Soni <jbsoni@uwaterloo.ca>
@Jaybsoni Jaybsoni reopened this Oct 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Documentation changes and updates good first issue Good for newcomers Hacktoberfest Participating in Hacktoberfest event
Projects
None yet
Development

No branches or pull requests

3 participants