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

Implement unified docs for Lightning Qubit and Kokkos #473

Merged
merged 68 commits into from
Aug 24, 2023
Merged

Conversation

AmintorDusko
Copy link
Contributor

@AmintorDusko AmintorDusko commented Aug 17, 2023

Context:
Adds single unified documentation for Lightning Qubit and Lightning Kokkos.
For reference:
https://docs.pennylane.ai/projects/lightning/en/latest/
https://docs.pennylane.ai/projects/lightning-kokkos/en/latest/

Description of the Change:

Benefits:

Possible Drawbacks:

Related GitHub Issues:

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@AmintorDusko
Copy link
Contributor Author

This work is still under development. I'm tagging you just for your information.

@AmintorDusko AmintorDusko changed the title docs initial push Implement unified docs for Lightning Qubit and Kokkos Aug 22, 2023
@mlxd
Copy link
Member

mlxd commented Aug 22, 2023

Just a quick request, the setup.py file needs a brief update for PyPI rendering, with the following change:

    "long_description_content_type": "text/x-rst",

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/lightning_qubit/device.rst Outdated Show resolved Hide resolved
doc/lightning_kokkos/device.rst Outdated Show resolved Hide resolved
doc/lightning_qubit/development/index.rst Outdated Show resolved Hide resolved
@trbromley
Copy link
Contributor

Other things we discussed:

  • Here - we'll document the two modules, and then inside each module we'll have the LightningQubit etc content. Similar to how it's done here.
  • Have sub-pages for installation
    • The lightning qubit one will include what's currently here
    • The lightning kokkos one can be more basic initially, but we can expand later on and also have room for lightning gpu
  • Here and in the Kokkos equivalent, we'll add a sentence linking the user to the appropriate installation instructions.

@AmintorDusko
Copy link
Contributor Author

Docs are ready, I think I covered all the topics we (Tom and I) discussed. I needed to adapt here the request below because our packaging structure is different from PennyLane and such a scheme would not work.

  • Here - we'll document the two modules, and then inside each module we'll have the LightningQubit etc content. Similar to how it's done here.

I would like to ask for a final round of review.

Copy link
Contributor

@vincentmr vincentmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll approve now, since I only have some questions and suggestions. This is a great (and important) job @AmintorDusko !

README.rst Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
doc/lightning_kokkos/device.rst Show resolved Hide resolved
doc/lightning_kokkos/device.rst Show resolved Hide resolved
Copy link
Contributor

@trbromley trbromley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @AmintorDusko!

doc/lightning_kokkos/device.rst Outdated Show resolved Hide resolved
doc/lightning_kokkos/installation.rst Show resolved Hide resolved
Copy link
Member

@mlxd mlxd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go!

@AmintorDusko AmintorDusko merged commit eade88c into master Aug 24, 2023
61 checks passed
@AmintorDusko AmintorDusko deleted the add/docs branch August 24, 2023 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants