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

Reorganized Backends Docs Page #2481

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

mawolf2023
Copy link
Contributor

Description

This PR cleans up the backends section of the docs and makes it easier to follow. This includes new figures and flowcharts to guide users to selecting the proper backend for their purposes.

Copy link

copy-pr-bot bot commented Dec 16, 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.

@bmhowe23
Copy link
Collaborator

bmhowe23 commented Dec 16, 2024

/ok to test

Command Bot: Processing...

docs/sphinx/using/backends/backends.png Outdated Show resolved Hide resolved
docs/sphinx/using/backends/backends.png Outdated Show resolved Hide resolved
docs/sphinx/using/backends/circuitsimulators.png Outdated Show resolved Hide resolved
docs/sphinx/using/backends/hardware/iontrap.rst Outdated Show resolved Hide resolved
docs/sphinx/using/backends/sims/othersims.rst Outdated Show resolved Hide resolved
docs/sphinx/using/backends/sims/othersims.rst Outdated Show resolved Hide resolved



Single-GPU (fp64)
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
Single-GPU (fp64)
Single-GPU

Copy link
Collaborator

Choose a reason for hiding this comment

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

Or add fp32 to the previous entry

Single-GPU (fp64)
++++++++++++++++++++++++

.. _nvidia-fp64-backend:
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 an entry for fp32 as well?


.. code:: bash

mpiexec -np 2 python3 program.py [...] --target nvidia --target-option fp32,mgpu
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe add something like this to the single GPU option

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 what do you mean by that? We already have this. Do you mean showing fp64? I also made the fp64 a subsection under nvidia.

.. code:: bash
python3 program.py [...] --target nvidia

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, I meant showing the code line both precision options under the single GPU option

Copy link
Collaborator

Choose a reason for hiding this comment

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

Looks better. I think the text should be consistent - either start with verb (simulate...) or use a noun (X simulation) for these four

Copy link
Collaborator

Choose a reason for hiding this comment

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

Cloud: I would say QPUs and GPUs hosted in the cloud rather than just in the cloud, to be more clear.
I think there is a way to make the white text one line:
Dynamics: Simulate quantum systems leveraging GPUs scalability
QPUs: Run applications on QPUs with varied modalities


.. code:: bash

mpiexec -np 2 python3 program.py [...] --target nvidia --target-option fp32,mgpu
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, I meant showing the code line both precision options under the single GPU option

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.

4 participants