CUDA-Q Docs Applications Section Reorg #2609

mawolf2023 · 2025-02-11T13:15:27Z

Description

This PR updates the applications section of the docs. Notebooks can now be tagged and dynamically filtered. Rather than a generic icon, each application has a description and a preview image.

Made minor fixes to backends simulator table

Updated simulator diagram to include noisy simulators

Fixed double link to backends page.

Added CUDA-QX Page

Signed-off-by: Mark Wolf <[email protected]>

copy-pr-bot · 2025-02-11T13:15:31Z

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.

khalatepradnya · 2025-02-11T16:56:37Z

/ok to test

Command Bot: Processing...

docs/sphinx/using/applications.rst

Co-authored-by: efratshabtai <[email protected]> Signed-off-by: mawolf2023 <[email protected]>

Signed-off-by: Mark Wolf <[email protected]>

khalatepradnya · 2025-02-12T16:51:02Z

/ok to test

Command Bot: Processing...

mawolf2023 · 2025-02-12T16:51:02Z

/ok to test

Command Bot: Processing...

Signed-off-by: Mark Wolf <[email protected]>

mawolf2023 · 2025-02-13T14:57:34Z

/ok to test

Command Bot: Processing...

khalatepradnya · 2025-02-13T19:18:46Z

/ok to test

Command Bot: Processing...

Signed-off-by: Mark Wolf <[email protected]>

mawolf2023 · 2025-02-27T20:40:19Z

/ok to test

Command Bot: Processing...

Signed-off-by: Mark Wolf <[email protected]>

* Removed old notebooks * Relative path updated, links fixed TODO: - Install `sphinx-tags` in the dev deps images or prior to building docs - Pass spell checker (notebook names) - Docs gen (duplicate reference definition) Signed-off-by: Pradnya Khalate <[email protected]>

docs/sphinx/applications/python/H 0-pyscf.log

docs/sphinx/applications/python/O 0-pyscf.log

docs/sphinx/applications/python/qaoa.ipynb

docs/sphinx/conf.py

-- ignore `'s` in C++ examples -- Ignore the names of notebook files Signed-off-by: Pradnya Khalate <[email protected]>

* Install `sphinx-tags` Co-authored-by: Mark Wolf <[email protected]> Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya · 2025-03-10T21:38:53Z

docs/sphinx/using/backends/simulators.rst

     - State Vector
     - General purpose (default); Trajectory simulation for noisy circuits
     - Single GPU
-     - single / double
+     - single / double (default)


Is this a typo? Single precision is default as per rest of our docs.

@efratshabtai Can you confirm?

@1tnguyen can you please go over the entire table and confirm?

For @1tnguyen:

Signed-off-by: Pradnya Khalate <[email protected]>

such as `"display_name": "Python 3"` --> `"display_name": "Python 3 (ipykernel)"`. Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya · 2025-03-10T22:24:30Z

.github/workflows/config/spelling_allowlist.txt

@@ -99,6 +99,7 @@ QPU
 QPUs
 QPU’s
 QTX
+QX


For CUDA-QX.

docs/sphinx/using/applications.rst

* Make spell checker happy (but docs gen fails) Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya · 2025-03-10T23:47:49Z

/ok to test

Command Bot: Processing...

Updated the preview image names accordingly. * Spellchecker happy; Docs gen working Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya · 2025-03-11T22:12:38Z

/ok to test

Command Bot: Processing...

github-actions · 2025-03-11T23:37:42Z

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

khalatepradnya · 2025-03-12T16:33:19Z

docs/sphinx/_static/custom.css

+ * This source code and the accompanying materials are made available under    *
+ * the terms of the Apache License 2.0 which accompanies this distribution.    *
+ *                                                                             *
+ * File: custom.css                                                            *


We don't have similar files in the source tree, so I don't know if the copyright banner format is same or different.
@schweitzpgi - can you provide pointers on the getting this one right for *.css and .*.js files?

efratshabtai · 2025-03-12T17:00:17Z

docs/sphinx/using/applications.rst

+
+
+   <div class="tag-filters" style="margin-top: 20px;">
+            <h3>Filter by Community:</h3>


I suggest adding community as another filter to the 'Filter by Domain' list, especially since we don't have many right now.

efratshabtai · 2025-03-12T19:59:09Z

docs/sphinx/using/applications.rst

+    </div>
+
+.. raw:: html
+


It will be nice to show all applicable tags (data-tags) for each application entry

efratshabtai · 2025-03-12T20:01:45Z

docs/sphinx/using/applications.rst

+        <div class="tag-filters" style="margin-top: 20px;">
+    <h3>Filter by Backend:</h3>
+    <div class="backend-group">
+        <button class="tag-button backend-toggle" data-tag="noiseless">Noiseless Simulator</button>


Should we add CPU? (do we have any apps that run on CPU only?)

docs/sphinx/using/applications.rst

efratshabtai · 2025-03-12T20:07:53Z

docs/sphinx/using/applications.rst

+    <div class="notebook-entry" data-tags="chemistry,optimization,noiseless,gpu">
+        <a href="/applications/python/digitized_counterdiabatic_QAOA.html" class="notebook-title">Digitized Counterdiabatic QAOA</a>
+        <div class="notebook-content">
+            This notebook explores application of DC-QAOA to predict molecules that might be good candidates for drugs based on their interactions with proteins.


I like the descriptions starting in 'Learn...' of the other notebooks, maybe we can use it here and in the previous one too.

efratshabtai · 2025-03-12T20:15:39Z

docs/sphinx/using/applications.rst

+    <div class="notebook-entry" data-tags="chemistry,qec,qpu,neutral,collab">
+        <a href="/applications/python/logical_aim_Sqale.html" class="notebook-title">The Anderson Impurity Model With Logical Qubits</a>
+        <div class="notebook-content">
+            A recent collaboration between NVIDIA and Infleqtion demonstrated a logical qubit workflow built in CUDA-Q and executed on the Infleqtion's neutral atom QPU.


Suggested change

A recent collaboration between NVIDIA and Infleqtion demonstrated a logical qubit workflow built in CUDA-Q and executed on the Infleqtion's neutral atom QPU.

A collaboration between NVIDIA and Infleqtion demonstrated a logical qubit workflow built in CUDA-Q and executed on the Infleqtion's neutral atom QPU.

Can link to the paper: https://arxiv.org/abs/2412.07670

Keeping 'unresolved' as reminder to add link to the paper.

docs/sphinx/using/applications.rst

reference to it in the script comments. Signed-off-by: Pradnya Khalate <[email protected]>

Co-authored-by: efratshabtai <[email protected]> Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya · 2025-03-13T16:28:46Z

/ok to test

Command Bot: Processing...

github-actions · 2025-03-13T18:00:26Z

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

mawolf2023 added 4 commits February 6, 2025 20:40

Applications with filter

b3ecd7f

Signed-off-by: Mark Wolf <[email protected]>

new applications.rst

d1778f3

Signed-off-by: Mark Wolf <[email protected]>

examples with solvers

b99a3e0

Signed-off-by: Mark Wolf <[email protected]>

Filters fixed, updated applications

a7385da

Signed-off-by: Mark Wolf <[email protected]>

efratshabtai reviewed Feb 11, 2025

View reviewed changes

mawolf2023 and others added 3 commits February 12, 2025 10:11

Update docs/sphinx/using/applications.rst

4738288

Co-authored-by: efratshabtai <[email protected]> Signed-off-by: mawolf2023 <[email protected]>

Drop down filters to backend, fixed dynamics page in backends

b6eaa28

Signed-off-by: Mark Wolf <[email protected]>

fix conflict

f91f2e7

Signed-off-by: Mark Wolf <[email protected]>

cudaqx page

d5e8eef

Signed-off-by: Mark Wolf <[email protected]>

schweitzpgi added the documentation Improvements or additions to documentation label Feb 14, 2025

mawolf2023 added 3 commits February 20, 2025 20:08

remove sphinx needs

e10f431

Signed-off-by: Mark Wolf <[email protected]>

remove cudaqx and add apapt qaoa

7b941da

Signed-off-by: Mark Wolf <[email protected]>

minor backend fixes, simulator figure update

b745ca6

Signed-off-by: Mark Wolf <[email protected]>

mawolf2023 and others added 4 commits February 27, 2025 21:09

conflicts resolved

f3f8484

Signed-off-by: Mark Wolf <[email protected]>

add license headers to .css and .js files

f990b31

Signed-off-by: Mark Wolf <[email protected]>

Merge branch 'main' into sort_by_tag

5687b7d

khalatepradnya reviewed Mar 10, 2025

View reviewed changes

khalatepradnya added 2 commits March 10, 2025 12:20

* Make spell checker happy

e4457c6

-- ignore `'s` in C++ examples -- Ignore the names of notebook files Signed-off-by: Pradnya Khalate <[email protected]>

* Content for two notebooks

4c95f2a

* Install `sphinx-tags` Co-authored-by: Mark Wolf <[email protected]> Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya reviewed Mar 10, 2025

View reviewed changes

khalatepradnya added 2 commits March 10, 2025 15:03

* Remove auto-generated files from source tree.

9c4935c

Signed-off-by: Pradnya Khalate <[email protected]>

* Fix output on QAOA notebook

ccfa657

Signed-off-by: Pradnya Khalate <[email protected]>

* Reduce the diff by restoring notebooks which had only metadata changes

8e64813

such as `"display_name": "Python 3"` --> `"display_name": "Python 3 (ipykernel)"`. Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya reviewed Mar 10, 2025

View reviewed changes

.github/workflows/config/spelling_allowlist.txt

@@ -99,6 +99,7 @@ QPU

QPUs

QPU’s

QTX

QX

Copy link

Collaborator

khalatepradnya Mar 10, 2025

Choose a reason for hiding this comment

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

For CUDA-QX.

khalatepradnya reviewed Mar 10, 2025

View reviewed changes

docs/sphinx/using/applications.rst Outdated Show resolved Hide resolved

* Move the installation of sphinx-tags to devdeps image

9b30ff5

* Make spell checker happy (but docs gen fails) Signed-off-by: Pradnya Khalate <[email protected]>

khalatepradnya added 3 commits March 11, 2025 11:51

Merge branch 'main' into sort_by_tag

5adde72

* Renamed notebooks to use capitalized proper names wherever applicable.

e070fa1

Updated the preview image names accordingly. * Spellchecker happy; Docs gen working Signed-off-by: Pradnya Khalate <[email protected]>

Merge branch 'main' into sort_by_tag

5be370a

github-actions bot pushed a commit that referenced this pull request Mar 11, 2025

Docs preview for PR #2609.

a45a0df

khalatepradnya reviewed Mar 12, 2025

View reviewed changes

efratshabtai reviewed Mar 12, 2025

View reviewed changes

khalatepradnya and others added 4 commits March 13, 2025 09:20

Merge branch 'main' into sort_by_tag

86cfff8

Since the AFQMC notebook was removed, doesn't make sense to have

5151cc8

reference to it in the script comments. Signed-off-by: Pradnya Khalate <[email protected]>

Apply suggestions from code review

815ce62

Co-authored-by: efratshabtai <[email protected]> Signed-off-by: Pradnya Khalate <[email protected]>

Merge branch 'main' into sort_by_tag

97c58cb

github-actions bot pushed a commit that referenced this pull request Mar 13, 2025

Docs preview for PR #2609.

ed22764

khalatepradnya requested a review from sacpis March 13, 2025 20:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CUDA-Q Docs Applications Section Reorg #2609

CUDA-Q Docs Applications Section Reorg #2609

mawolf2023 commented Feb 11, 2025 •

edited

Loading

copy-pr-bot bot commented Feb 11, 2025

khalatepradnya commented Feb 11, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Feb 12, 2025 •

edited by github-actions bot

Loading

mawolf2023 commented Feb 12, 2025 •

edited by github-actions bot

Loading

mawolf2023 commented Feb 13, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Feb 13, 2025 •

edited by github-actions bot

Loading

mawolf2023 commented Feb 27, 2025 •

edited by github-actions bot

Loading

khalatepradnya Mar 10, 2025

mawolf2023 Mar 11, 2025

efratshabtai Mar 11, 2025

khalatepradnya Mar 11, 2025

khalatepradnya Mar 10, 2025

khalatepradnya commented Mar 10, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Mar 11, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Mar 11, 2025

khalatepradnya Mar 12, 2025

efratshabtai Mar 12, 2025

efratshabtai Mar 12, 2025

efratshabtai Mar 12, 2025

efratshabtai Mar 12, 2025

efratshabtai Mar 12, 2025

efratshabtai Mar 12, 2025

khalatepradnya Mar 13, 2025

khalatepradnya commented Mar 13, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Mar 13, 2025

@@ @@ -99,6 +99,7 @@ QPU @@
               QPUs
               QPU’s
               QTX
+              QX



		<div class="tag-filters" style="margin-top: 20px;">
		<h3>Filter by Community:</h3>

	A recent collaboration between NVIDIA and Infleqtion demonstrated a logical qubit workflow built in CUDA-Q and executed on the Infleqtion's neutral atom QPU.
	A collaboration between NVIDIA and Infleqtion demonstrated a logical qubit workflow built in CUDA-Q and executed on the Infleqtion's neutral atom QPU.

CUDA-Q Docs Applications Section Reorg #2609

Are you sure you want to change the base?

CUDA-Q Docs Applications Section Reorg #2609

Conversation

mawolf2023 commented Feb 11, 2025 • edited Loading

Description

copy-pr-bot bot commented Feb 11, 2025

khalatepradnya commented Feb 11, 2025 • edited by github-actions bot Loading

khalatepradnya commented Feb 12, 2025 • edited by github-actions bot Loading

mawolf2023 commented Feb 12, 2025 • edited by github-actions bot Loading

mawolf2023 commented Feb 13, 2025 • edited by github-actions bot Loading

khalatepradnya commented Feb 13, 2025 • edited by github-actions bot Loading

mawolf2023 commented Feb 27, 2025 • edited by github-actions bot Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khalatepradnya commented Mar 10, 2025 • edited by github-actions bot Loading

khalatepradnya commented Mar 11, 2025 • edited by github-actions bot Loading

github-actions bot commented Mar 11, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khalatepradnya commented Mar 13, 2025 • edited by github-actions bot Loading

github-actions bot commented Mar 13, 2025

mawolf2023 commented Feb 11, 2025 •

edited

Loading

khalatepradnya commented Feb 11, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Feb 12, 2025 •

edited by github-actions bot

Loading

mawolf2023 commented Feb 12, 2025 •

edited by github-actions bot

Loading

mawolf2023 commented Feb 13, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Feb 13, 2025 •

edited by github-actions bot

Loading

mawolf2023 commented Feb 27, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Mar 10, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Mar 11, 2025 •

edited by github-actions bot

Loading

khalatepradnya commented Mar 13, 2025 •

edited by github-actions bot

Loading