Restructure of examples and applications #2218

zohimchandani · 2024-09-19T11:59:30Z

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 · 2024-09-19T11:59:33Z

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.

docs/sphinx/examples/python/tutorials/digitized_counterdiabatic_qaoa.ipynb

docs/sphinx/examples/python/tutorials/vqe_advanced.ipynb

sacpis

Few changes are needed.

sacpis · 2024-09-19T21:18:50Z

Command Bot: Processing...

sacpis · 2024-09-19T21:38:38Z

Command Bot: Processing...

sacpis · 2024-09-19T22:14:30Z

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

…densed) as part of PR NVIDIA#2218

sacpis · 2024-09-19T22:50:02Z

Command Bot: Processing...

sacpis · 2024-09-19T23:45:04Z

Command Bot: Processing...

sacpis · 2024-09-20T01:01:28Z

@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 · 2024-09-23T12:17:09Z

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 · 2024-09-23T12:18:39Z

Command Bot: Processing...

sacpis · 2024-09-23T15:25:07Z

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 · 2024-10-10T21:23:42Z

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

docs/CMakeLists.txt

docs/sphinx/applications/python/afqmc_src/estimates.0.h5

docs/sphinx/applications/python/afqmc_src/output.chk

scripts/validate_wheel.sh

* Removing unnecessary binary files

sacpis · 2024-10-11T21:27:27Z

Command Bot: Processing...

sacpis · 2024-10-12T01:15:57Z

Command Bot: Processing...

bmhowe23 · 2024-10-14T17:14:20Z

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 · 2024-10-14T17:18:33Z

Command Bot: Processing...

sacpis · 2024-10-15T20:33:05Z

Command Bot: Processing...

sacpis · 2024-10-16T00:15:22Z

@bmhowe23 Comment updated at the top of the thread.

sacpis · 2024-10-16T00:15:34Z

Command Bot: Processing...

bmhowe23

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 · 2024-10-16T21:53:18Z

Command Bot: Processing...

sacpis · 2024-10-16T23:32:53Z

Command Bot: Processing...

* 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 <[email protected]> I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 7a4adc5 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: d8f4410 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 6ce6695 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 636bcc0 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 9321724 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 72ead24 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 5517077 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 0eb6b44 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 91c317b I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: ee09e73 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 9f17e73 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: e47acd2 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 4e24921 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 1f412a6 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 3b580a1 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 8fd380e I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: f1df271 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 9eb9ab8 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 2eb4882 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: ffd54a5 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 8b702e6 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: f2cb3c6 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 00490c8 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 0e5ec8e I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 7553eed I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 8782cef I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 2afb6bd I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 17ac800 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 79879ea I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: 5ebd717 I, Sachin Pisal <[email protected]>, hereby add my Signed-off-by to this commit: b8076e8 Signed-off-by: Sachin Pisal <[email protected]> * DCO Remediation Commit for Ben Howe <[email protected]> I, Ben Howe <[email protected]>, hereby add my Signed-off-by to this commit: 6153db0 I, Ben Howe <[email protected]>, hereby add my Signed-off-by to this commit: 078c3ed Signed-off-by: Ben Howe <[email protected]> * 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 <[email protected]> Signed-off-by: Ben Howe <[email protected]> Co-authored-by: Ben Howe <[email protected]> Co-authored-by: Ben Howe <[email protected]> Co-authored-by: Sachin Pisal <[email protected]> Co-authored-by: root <[email protected]> Signed-off-by: Anna Gringauze <[email protected]>

zohimchandani and others added 9 commits August 28, 2024 16:27

new tutorial

a710578

updates

5e13b83

Add ipywidgets to devdeps image for docs generation

6153db0

Formatting and spelling

078c3ed

Merge branch 'main' into main

08af2f8

Merge branch 'NVIDIA:main' into main

cebc007

Merge branch 'NVIDIA:main' into main

f7b34c4

cleanup of docs

0387c26

restructure of examples and applications pages

a2dc213

zohimchandani requested a review from sacpis September 19, 2024 11:59

sacpis reviewed Sep 19, 2024

View reviewed changes

docs/sphinx/examples/python/tutorials/digitized_counterdiabatic_qaoa.ipynb Outdated Show resolved Hide resolved

sacpis reviewed Sep 19, 2024

View reviewed changes

docs/sphinx/examples/python/tutorials/vqe_advanced.ipynb Outdated Show resolved Hide resolved

adding a blank line

7a4adc5

sacpis reviewed Sep 19, 2024

View reviewed changes

Merge branch 'main' into main

e0b7dbe

ran digitized_counterdiabatic_qaoa.ipynb to save the output

d8f4410

removing tests as the Python (*.py) files have been moved out (or con…

6ce6695

…densed) as part of PR NVIDIA#2218

commenting out nvidia target and fixing duplicate htest definition

636bcc0

saving output from advanced vqe

705842b

updates

7ffbf3c

github-actions bot pushed a commit that referenced this pull request Oct 10, 2024

Docs preview for PR #2218.

794db1e

bmhowe23 reviewed Oct 11, 2024

View reviewed changes

docs/CMakeLists.txt Outdated Show resolved Hide resolved

bmhowe23 reviewed Oct 11, 2024

View reviewed changes

docs/sphinx/applications/python/afqmc_src/estimates.0.h5 Outdated Show resolved Hide resolved

bmhowe23 reviewed Oct 11, 2024

View reviewed changes

docs/sphinx/applications/python/afqmc_src/output.chk Outdated Show resolved Hide resolved

bmhowe23 reviewed Oct 11, 2024

View reviewed changes

scripts/validate_wheel.sh Outdated Show resolved Hide resolved

* Adding applications and targets folder

1ed812e

* Removing unnecessary binary files

adding pycudaq test for intro.py

bbbb241

removing warnings from the cell output

8d9ac55

Merge branch 'main' into main

9b66696

Merge branch 'main' into main

c66e8b8

sacpis enabled auto-merge October 16, 2024 00:15

sacpis requested a review from 1tnguyen October 16, 2024 00:55

bmhowe23 approved these changes Oct 16, 2024

View reviewed changes

sacpis disabled auto-merge October 16, 2024 02:59

Merge branch 'main' into main

29e30fa

Merge branch 'main' into main

9d27cdf

sacpis enabled auto-merge (squash) October 16, 2024 23:33

sacpis merged commit 5fbbfcf into NVIDIA:main Oct 17, 2024
132 checks passed

bettinaheim added this to the release 0.9.0 milestone Nov 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure of examples and applications #2218

Restructure of examples and applications #2218

zohimchandani commented Sep 19, 2024 •

edited by sacpis

Loading

copy-pr-bot bot commented Sep 19, 2024

sacpis left a comment

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 19, 2024

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 20, 2024

zohimchandani commented Sep 23, 2024

zohimchandani commented Sep 23, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 23, 2024

github-actions bot commented Oct 10, 2024

sacpis commented Oct 11, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 12, 2024 •

edited by github-actions bot

Loading

bmhowe23 commented Oct 14, 2024

sacpis commented Oct 14, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 15, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 16, 2024

sacpis commented Oct 16, 2024 •

edited by github-actions bot

Loading

bmhowe23 left a comment

sacpis commented Oct 16, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 16, 2024 •

edited by github-actions bot

Loading

Restructure of examples and applications #2218

Restructure of examples and applications #2218

Conversation

zohimchandani commented Sep 19, 2024 • edited by sacpis Loading

copy-pr-bot bot commented Sep 19, 2024

sacpis left a comment

Choose a reason for hiding this comment

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

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

sacpis commented Sep 19, 2024

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

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

sacpis commented Sep 20, 2024

zohimchandani commented Sep 23, 2024

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

sacpis commented Sep 23, 2024

github-actions bot commented Oct 10, 2024

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

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

bmhowe23 commented Oct 14, 2024

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

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

sacpis commented Oct 16, 2024

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

bmhowe23 left a comment

Choose a reason for hiding this comment

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

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

zohimchandani commented Sep 19, 2024 •

edited by sacpis

Loading

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

sacpis commented Sep 19, 2024 •

edited by github-actions bot

Loading

zohimchandani commented Sep 23, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 11, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 12, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 14, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 15, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 16, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 16, 2024 •

edited by github-actions bot

Loading

sacpis commented Oct 16, 2024 •

edited by github-actions bot

Loading