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

CUDA-Q Docs Applications Section Reorg #2609

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from

Conversation

mawolf2023
Copy link
Contributor

@mawolf2023 mawolf2023 commented Feb 11, 2025

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

Copy link

copy-pr-bot bot commented Feb 11, 2025

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
Copy link
Collaborator

khalatepradnya commented Feb 11, 2025

/ok to test

Command Bot: Processing...

@khalatepradnya
Copy link
Collaborator

khalatepradnya commented Feb 12, 2025

/ok to test

Command Bot: Processing...

@mawolf2023
Copy link
Contributor Author

mawolf2023 commented Feb 12, 2025

/ok to test

Command Bot: Processing...

Signed-off-by: Mark Wolf <[email protected]>
@mawolf2023
Copy link
Contributor Author

mawolf2023 commented Feb 13, 2025

/ok to test

Command Bot: Processing...

@khalatepradnya
Copy link
Collaborator

khalatepradnya commented Feb 13, 2025

/ok to test

Command Bot: Processing...

@schweitzpgi schweitzpgi added the documentation Improvements or additions to documentation label Feb 14, 2025
@mawolf2023
Copy link
Contributor Author

mawolf2023 commented Feb 27, 2025

/ok to test

Command Bot: Processing...

mawolf2023 and others added 4 commits February 27, 2025 21:09
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]>
  -- 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]>
- State Vector
- General purpose (default); Trajectory simulation for noisy circuits
- Single GPU
- single / double
- single / double (default)
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@efratshabtai Can you confirm?

Copy link
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

For @1tnguyen:
image

  such as `"display_name": "Python 3"` --> `"display_name": "Python 3
(ipykernel)"`.

Signed-off-by: Pradnya Khalate <[email protected]>
@@ -99,6 +99,7 @@ QPU
QPUs
QPU’s
QTX
QX
Copy link
Collaborator

Choose a reason for hiding this comment

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

For CUDA-QX.

* Make spell checker happy (but docs gen fails)

Signed-off-by: Pradnya Khalate <[email protected]>
@khalatepradnya
Copy link
Collaborator

khalatepradnya commented Mar 10, 2025

/ok to test

Command Bot: Processing...

@khalatepradnya
Copy link
Collaborator

khalatepradnya commented Mar 11, 2025

/ok to test

Command Bot: Processing...

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

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

* 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 *
Copy link
Collaborator

Choose a reason for hiding this comment

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

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?



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

Choose a reason for hiding this comment

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

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

</div>

.. raw:: html

Copy link
Collaborator

Choose a reason for hiding this comment

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

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

<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>
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

<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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

<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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

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

@khalatepradnya
Copy link
Collaborator

khalatepradnya commented Mar 13, 2025

/ok to test

Command Bot: Processing...

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

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

@khalatepradnya khalatepradnya requested a review from sacpis March 13, 2025 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants