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

Categorizing the qubit gates in the documentation #1566

Closed
albi3ro opened this issue Aug 20, 2021 · 2 comments
Closed

Categorizing the qubit gates in the documentation #1566

albi3ro opened this issue Aug 20, 2021 · 2 comments
Labels
code together Issues participating in PennyLane: Code Together documentation 📘 Documentation changes and updates

Comments

@albi3ro
Copy link
Contributor

albi3ro commented Aug 20, 2021

Now that qubit gates are sorted into categories in the code base, we should do so as well in the documentation section on operations. This change will help organize a list that is getting rather long, and help users find the operations in the code easier.

Instead of the section:

Qubit gates
^^^^^^^^

We should instead have a series of sections for

  • Observables (already exists)
  • Non-parametric Ops
  • Parametric Ops
  • State preparations (already exists)
  • Quantum Chemistry ops
  • Matrix ops
  • Arithmetic ops

The sorting should follow the division of operations in pennylane/ops/qubit.

@albi3ro albi3ro added documentation 📘 Documentation changes and updates code together Issues participating in PennyLane: Code Together labels Aug 20, 2021
@Pratul-Saini
Copy link
Contributor

Will the Hamiltonian operation be placed in it's own category as it is in pennylane/ops/qubit? Also, given that the Pauli matrices are also observables, should we also include them under the qubit observable section or just simply mirror what is in code?

@antalszava
Copy link
Contributor

Hi @Pratul-Saini, thanks for your interest! 🙂

Will the Hamiltonian operation be placed in it's own category as it is in pennylane/ops/qubit?

Maybe, for now, we could have it listed under the observables. There are some ongoing changes made to this class, we could modify its place in the list if need be.

Also, given that the Pauli matrices are also observables, should we also include them under the qubit observable section or just simply mirror what is in code?

They could be included at multiple places. That way they are for sure not missed. 🙂

albi3ro pushed a commit that referenced this issue Aug 24, 2021
… (#1584)

* Categorized qubit gates in documentation

* Removed Identity under Shared Operations

* Added new contribution and contributor

* Added SISWAP and SQISW operations in qubit ops

* fixed formatting from other pull

* Updated operations.rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code together Issues participating in PennyLane: Code Together documentation 📘 Documentation changes and updates
Projects
None yet
Development

No branches or pull requests

3 participants