KEMBAR78
Restructure of examples and applications by zohimchandani · Pull Request #2218 · NVIDIA/cuda-quantum · GitHub
Skip to content

Restructure of examples and applications #2218

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 71 commits into from
Oct 17, 2024
Merged

Restructure of examples and applications #2218

merged 71 commits into from
Oct 17, 2024

Conversation

@zohimchandani
Copy link
Collaborator

@zohimchandani zohimchandani commented Sep 19, 2024 •
edited by sacpis
Loading

Examples section: aim is to show how to use CUDA-Q syntax.

Applications section: aim to show various useful things you can build with CUDA-Q.

Restructure of both sections, added new ones, deleted repeated ones and condensed ones that could be condensed.

This work is in collaboration with @mawolf2023 who did most of the heavy lifting here.

At the higher level, the structure would look like

docs/sphinx
    - applications
         - cpp
         - python
    - examples
         - cpp
         - python
    - targets
         - cpp
         - python

The structure in the released docker image would look like below

/home/cudaq
    - applications
         - cpp
         - python
    - examples
         - cpp
         - python
    - targets
         - cpp
         - python

@copy-pr-bot
Copy link

copy-pr-bot bot commented Sep 19, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

sacpis
sacpis reviewed Sep 19, 2024
View reviewed changes
sacpis
sacpis reviewed Sep 19, 2024
View reviewed changes
Copy link
Collaborator

@sacpis sacpis left a comment

Choose a reason for hiding this comment

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

Few changes are needed.

@sacpis
Copy link
Collaborator

sacpis commented Sep 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Sep 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Sep 19, 2024

@efratshabtai Adding Efrat for visibility as the Python examples have been moved.

@sacpis
Copy link
Collaborator

sacpis commented Sep 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Sep 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Sep 20, 2024

@zohimchandani Seems like as we have purged *.py files from examples/python, we will need to update .rst files under docs/sphinx/using/examples/.rst. Would you please update those *.rst files?

@zohimchandani
Copy link
Collaborator Author

@zohimchandani Seems like as we have purged *.py files from examples/python, we will need to update .rst files under docs/sphinx/using/examples/.rst. Would you please update those *.rst files?

Examples now contain a mixture of notebooks + rst files. The docs/sphinx/using/examples/examples.rst lays out the order of these files and is already updated. Is this sufficient or you want me to look at something else?

Thanks.

@zohimchandani
Copy link
Collaborator Author

zohimchandani commented Sep 23, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Sep 23, 2024

Hey @zohimchandani,

We will need to update .rst files under docs/sphinx/examples/using/examples/.rst. These *.rst files points to examples with *.py files which we have moved in this PR.

@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Oct 10, 2024
@cuda-quantum-bot
Docs preview for PR #2218.
794db1e
bmhowe23
bmhowe23 reviewed Oct 11, 2024
View reviewed changes
bmhowe23
bmhowe23 reviewed Oct 11, 2024
View reviewed changes
bmhowe23
bmhowe23 reviewed Oct 11, 2024
View reviewed changes
bmhowe23
bmhowe23 reviewed Oct 11, 2024
View reviewed changes
@sacpis
* Adding applications and targets folder
1ed812e 
* Removing unnecessary binary files
@sacpis
Copy link
Collaborator

sacpis commented Oct 11, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Oct 12, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@bmhowe23
Copy link
Collaborator

At the higher level, the structure would look like

docs/sphinx
    - applications
         - cpp
         - python
    - examples
         - cpp
         - python
    - targets
         - cpp
         - python

What would the resulting structure be in our delivered Docker image? I think it would be good to document that in the comment at the top of the thread. Some of the affected scripts (nightly integration script, etc.) cannot be tested with regular CI, so it would be helpful during the review to know what the resulting Docker image file layout will be for these examples/applications/targets.

@sacpis
Copy link
Collaborator

sacpis commented Oct 14, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Oct 15, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Oct 16, 2024

@bmhowe23 Comment updated at the top of the thread.

@sacpis
Copy link
Collaborator

sacpis commented Oct 16, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis sacpis enabled auto-merge October 16, 2024 00:15
@sacpis sacpis requested a review from 1tnguyen October 16, 2024 00:55
bmhowe23
bmhowe23 approved these changes Oct 16, 2024
View reviewed changes
Copy link
Collaborator

@bmhowe23 bmhowe23 left a comment

Choose a reason for hiding this comment

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

This looks good to me a from a script and Dockerfile perspective. Hopefully @efratshabtai or others can comment on or approve the content changes.

@sacpis sacpis disabled auto-merge October 16, 2024 02:59
@sacpis
Copy link
Collaborator

sacpis commented Oct 16, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis
Copy link
Collaborator

sacpis commented Oct 16, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@sacpis sacpis enabled auto-merge (squash) October 16, 2024 23:33
@sacpis sacpis merged commit 5fbbfcf into NVIDIA:main Oct 17, 2024
132 checks passed
copy-pr-bot bot pushed a commit that referenced this pull request Oct 17, 2024
@zohimchandani @bmhowe23
@sacpis @annagrin
Restructure of examples and applications (#2218)
b3739cb 
* new tutorial

* updates

* Add ipywidgets to devdeps image for docs generation

* Formatting and spelling

* cleanup of docs

* restructure of examples and applications pages

* adding a blank line

* ran digitized_counterdiabatic_qaoa.ipynb to save the output

* removing tests as the Python (*.py) files have been moved out (or condensed) as part of PR #2218

* commenting out nvidia target and fixing duplicate htest definition

* saving output from advanced vqe

* updates

* renaming tutorials -> applications

* purging unused rst files

* * Adding missing image in the images folder
* Correcting the image path in ipynb
* Setting nbsphinx_widgets_path to empty string (to resolve this warning
  generated during sphinx docs generation
  WARNING: nbsphinx_widgets_path not given and ipywidgets module unavailable)

* adding double quotes around the target

* changing number of qpus to pass CI

* adding intro.py and making changes to rst file to include ipynb file

* moving applications, examples, targets into dedicated folders

* changing path

* adding applications and targets directories

* changing path for hardware providers and few python files

* fixing path

* adding paths

* adding applications path

* adding python notebook directly in rst file

* removign maxdepth

* fixing paths

* adding targets path

* adding paths

* removing providers and tutorials path

* clearing output

* adding a building_kernels python file in order to render it under tabs

* correcting spelling check and formatting

* excluding /building_kernels.py

* adding missing examples and removing warnings from the output

* commenting nvidia target

* removing nbsphinx_widgets_path

* changing VQE title

* DCO Remediation Commit for Sachin Pisal <spisal@nvidia.com>

I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 7a4adc5
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: d8f4410
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 6ce6695
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 636bcc0
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 9321724
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 72ead24
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 5517077
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 0eb6b44
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 91c317b
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: ee09e73
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 9f17e73
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: e47acd2
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 4e24921
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 1f412a6
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 3b580a1
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 8fd380e
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: f1df271
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 9eb9ab8
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 2eb4882
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: ffd54a5
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 8b702e6
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: f2cb3c6
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 00490c8
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 0e5ec8e
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 7553eed
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 8782cef
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 2afb6bd
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 17ac800
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 79879ea
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: 5ebd717
I, Sachin Pisal <spisal@nvidia.com>, hereby add my Signed-off-by to this commit: b8076e8

Signed-off-by: Sachin Pisal <spisal@nvidia.com>

* DCO Remediation Commit for Ben Howe <bhowe@nvidia.com>

I, Ben Howe <bhowe@nvidia.com>, hereby add my Signed-off-by to this commit: 6153db0
I, Ben Howe <bhowe@nvidia.com>, hereby add my Signed-off-by to this commit: 078c3ed

Signed-off-by: Ben Howe <bhowe@nvidia.com>

* sign

* * Adding applications and targets folder
* Removing unnecessary binary files

* adding pycudaq test for intro.py

* removing warnings from the cell output

---------

Signed-off-by: Sachin Pisal <spisal@nvidia.com>
Signed-off-by: Ben Howe <bhowe@nvidia.com>
Co-authored-by: Ben Howe <bhowe@nvidia.com>
Co-authored-by: Ben Howe <141149032+bmhowe23@users.noreply.github.com>
Co-authored-by: Sachin Pisal <spisal@nvidia.com>
Co-authored-by: root <root@fi-kermit.nvidia.com>
Signed-off-by: Anna Gringauze <agringauze@nvidia.com>
@bettinaheim bettinaheim added this to the release 0.9.0 milestone Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sacpis sacpis sacpis left review comments

@efratshabtai efratshabtai efratshabtai left review comments

@bmhowe23 bmhowe23 bmhowe23 approved these changes

@bettinaheim bettinaheim Awaiting requested review from bettinaheim bettinaheim is a code owner

@amccaskey amccaskey Awaiting requested review from amccaskey

@1tnguyen 1tnguyen Awaiting requested review from 1tnguyen 1tnguyen is a code owner

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

release 0.9.0

Development

Successfully merging this pull request may close these issues.

7 participants

@zohimchandani @sacpis @mawolf2023 @bmhowe23 @efratshabtai @bettinaheim @khalatepradnya