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

Covalent Cloud GPU tutorial #1101

Merged
merged 19 commits into from
May 23, 2024
Merged

Covalent Cloud GPU tutorial #1101

merged 19 commits into from
May 23, 2024

Conversation

kessler-frost
Copy link
Contributor

@kessler-frost kessler-frost commented May 14, 2024


Title: Running GPU-accelerated quantum circuit simulations on Covalent Cloud using PennyLane

Summary:

Relevant references:

Possible Drawbacks:

Related GitHub Issues:


If you are writing a demonstration, please answer these questions to facilitate the marketing process.

  • GOALS — Why are we working on this now?

    Eg. Promote a new PL feature or show a PL implementation of a recent paper.

  • AUDIENCE — Who is this for?

    Eg. Chemistry researchers, PL educators, beginners in quantum computing.

  • KEYWORDS — What words should be included in the marketing post?

  • Which of the following types of documentation is most similar to your file?
    (more details here)

  • Tutorial
  • Demo
  • How-to

@kessler-frost
Copy link
Contributor Author

CC: @araghukas @santoshkumarradha

@kessler-frost
Copy link
Contributor Author

kessler-frost commented May 14, 2024

One issue I had when converting this from a jupyter notebook to a .py file using notebook_to_demo.py was this error:

python notebook_converter/notebook_to_demo.py covalent_cloud_gpu.ipynb --is-executable=False
Traceback (most recent call last):
  File "/Users/neptune/dev/qml/notebook_converter/notebook_to_demo.py", line 360, in <module>
    nb_py = convert_notebook_to_python(
  File "/Users/neptune/dev/qml/notebook_converter/notebook_to_demo.py", line 262, in convert_notebook_to_python
    cell_id = cell["id"]
KeyError: 'id'

I circumvented it by editing Line 262 to cell_id = i instead.

@kessler-frost kessler-frost marked this pull request as ready for review May 17, 2024 12:30
@ikurecic
Copy link
Contributor

Hi @kessler-frost , thank you so much for making the updates and marking the pull request as ready for review!
I can't push directly to your branch because it's in an organization-owned fork

Could you please add the following thumbnails to the pull request?

  • thumbnail_covalent_cloud_gpu.png to the demonstration_assets/covalent_cloud_gpu/ folder
    thumbnail_covalent_cloud_gpu_pennylane
  • thumbnail_large_covalent_cloud_gpu.png to the large_demo_thumbnails folder
    thumbnail_large_covalent_cloud_gpu_pennylane

You can also transfer the included plot into the demonstrations_assets folder by following the instructions here with the syntax below.

##############################################################################
#.. figure:: ../_static/demonstrations_assets/<demo name>/image.png
#    :align: center
#    :width: 90%

It would be great if you could also complete the metadata file by following the readme instructions, so we can include everything in the review. (You can also look at a recently merged demo to check if anything might be missing, e.g., this one.)
If you're not sure about the dates, put down estimates that we can change later.

For the visuals in the metadata file, you can include this:

    "previewImages": [  
        {
            "type": "thumbnail",
            "uri": "/_static/demonstration_assets/covalent_cloud_gpu/thumbnail_covalent_cloud_gpu.png"
        },
        {
            "type": "large_thumbnail",
            "uri": "/_static/large_demo_thumbnails/thumbnail_large_covalent_cloud_gpu.png"
        }
    ],

Once metadata can be validated, we can also check out the deployment preview as part of the review.

Please let me know if you have any questions or concerns.

@kessler-frost
Copy link
Contributor Author

Thanks a lot @ikurecic ! Updated the PR ✅ . Hopefully I haven't missed anything else 🤞 .

You can also transfer the included plot into the demonstrations_assets folder by following the instructions here with the syntax below.

My bad actually I must've missed the right dir when converting it from .ipynb, updated ✅ .

Copy link

github-actions bot commented May 18, 2024

Thank you for opening this pull request.

You can find the built site at this link.

Deployment Info:

  • Pull Request ID: 1101
  • Deployment SHA: fd904ea1dc1c5154106e8ac3a2ac72ee55e8058c
    (The Deployment SHA refers to the latest commit hash the docs were built from)

Note: It may take several minutes for updates to this pull request to be reflected on the deployed site.

"weight": 1.0
}
],
"hardware": []
Copy link
Member

@josh146 josh146 May 21, 2024

Choose a reason for hiding this comment

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

Suggested change
"hardware": []
"hardware": [
{
"id": "covalent",
"link": "https://docs.covalent.xyz/docs/cloud/tutorials-cloud/pennylane_tutorial/",
"logo": "/_static/hardware_logos/covalent.png"
}
]

This suggestion can be applied after #1112 is merged in (cc @ikurecic)

@kessler-frost
Copy link
Contributor Author

Thanks @josh146 !

@josh146
Copy link
Member

josh146 commented May 23, 2024

Hey @kessler-frost, would you be able to give us permissions to push to this branch :) That way we can help out with some of the operations here.

@wjcunningham7
Copy link

Hey @kessler-frost, would you be able to give us permissions to push to this branch :) That way we can help out with some of the operations here.

You should have access now @josh146

@josh146
Copy link
Member

josh146 commented May 23, 2024

@wjcunningham7 thank you!

@josh146 josh146 merged commit ee5d5c3 into PennyLaneAI:master May 23, 2024
10 checks passed
@josh146
Copy link
Member

josh146 commented May 23, 2024

Hey all! There was a slight accident when I tried to merge the master branch of the QML repo into this PR --- I think because the forked repo did not create a new branch (and instead used master as the branch), the sync caused this PR to be accidentally merged.

I've reverted the merge, and everything is find, but it doesn't look like I am able to re-open this PR. To try and fix this, I create a new PR, this time with a new branch name (not master), here: #1115

@kessler-frost you should have full access to push to this PR.

Apologies!

@kessler-frost
Copy link
Contributor Author

Thanks @josh146 !

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

4 participants