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 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
fa6ff04
Updated Backends Section
mawolf2023 Dec 16, 2024
0bc2771
Removed Logos
mawolf2023 Dec 16, 2024
6c4305e
larger image text size
mawolf2023 Dec 16, 2024
a6efc5d
Added Table and cloud section
mawolf2023 Dec 17, 2024
818e8ea
Added python/c++ tabs and Efrat's comments
mawolf2023 Dec 17, 2024
de37d2f
Updated table, Backend Figure, And condensed fp64
mawolf2023 Dec 19, 2024
eead204
fixed typo
mawolf2023 Dec 20, 2024
878079f
Merge branch 'main' into backends
schweitzpgi Jan 2, 2025
a55163c
Update docs/sphinx/using/backends/backends.rst
mawolf2023 Jan 16, 2025
d9bf00f
Review Changes 1/17
mawolf2023 Jan 17, 2025
e57067a
Figure fix
mawolf2023 Jan 17, 2025
0ff31d4
DCO Remediation Commit for Mark Wolf <[email protected]>
mawolf2023 Jan 22, 2025
cb47c97
Merge branch 'main' into backends
mawolf2023 Jan 27, 2025
2f2cf12
Merge branch 'main' into backends
bmhowe23 Jan 27, 2025
fa09854
* Merging with mainline
khalatepradnya Jan 29, 2025
4291f8c
Merge branch 'main' into backends
khalatepradnya Jan 29, 2025
bfb3ae1
DCO Remediation Commit for Pradnya Khalate <[email protected]>
khalatepradnya Jan 29, 2025
0af0e29
* Fix spellings
khalatepradnya Jan 29, 2025
2601da2
Photonics plus multi-gpu examples and some ref updates
Jan 31, 2025
efc48e6
Merge branch 'main' into backends
khalatepradnya Jan 31, 2025
52dae08
* Fix links for docs generation
khalatepradnya Jan 31, 2025
34c85d9
* Spelling fixes
khalatepradnya Feb 1, 2025
a62c415
* Few more corrections to spellings
khalatepradnya Feb 1, 2025
e3052dd
Merge branch 'main' into backends
khalatepradnya Feb 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ You are browsing the documentation for |version| version of CUDA-Q. You can find
Other Versions <versions.rst>

.. |---| unicode:: U+2014 .. EM DASH
:trim:
:trim:
Binary file added docs/sphinx/using/backends/backends.png
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 17 additions & 35 deletions docs/sphinx/using/backends/backends.rst
Original file line number Diff line number Diff line change
@@ -1,41 +1,23 @@
*************************
CUDA-Q Backends
**********************
*************************
The CUDA-Q platform has is a powerful tool with many different backends for running hybrid quatum applications and other simulations. This page will help you understand what backends are availible and what the best choices are for your purpose.

.. toctree::
:caption: Backend Targets
:maxdepth: 1
The figure below groups the backends into five categories, and described the general purpose for each. See the following sections for a breakdown of the backends included in each section.
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved

Simulation <simulators.rst>
Quantum Hardware <hardware.rst>
NVIDIA Quantum Cloud <nvqc.rst>
Multi-Processor Platforms <platform.rst>
.. image:: backends.png
:width: 1000

**The following is a comprehensive list of the available targets in CUDA-Q:**
Click on the links below for each catagory to learn more about the backends it contains. the list below also covers all of the backends availible in CUDA-Q.

* :ref:`anyon <anyon-backend>`
* :ref:`braket <braket-backend>`
* :ref:`density-matrix-cpu <default-simulator>`
* :ref:`fermioniq <fermioniq-backend>`
* :ref:`infleqtion <infleqtion-backend>`
* :ref:`ionq <ionq-backend>`
* :ref:`iqm <iqm-backend>`
* :ref:`nvidia <nvidia-backend>`
* :ref:`nvidia-fp64 <nvidia-fp64-backend>`
* :ref:`nvidia-mgpu <nvidia-mgpu-backend>`
* :ref:`nvidia-mqpu <mqpu-platform>`
* :ref:`nvidia-mqpu-fp64 <mqpu-platform>`
* :doc:`nvqc <nvqc>`
* :ref:`oqc <oqc-backend>`
* :ref:`orca <orca-backend>`
* :ref:`qpp-cpu <qpp-cpu-backend>`
* :ref:`quantinuum <quantinuum-backend>`
* :ref:`quera <quera-backend>`
* :ref:`remote-mqpu <mqpu-platform>`
* :ref:`stim <stim-backend>`
* :ref:`tensornet <tensor-backends>`
* :ref:`tensornet-mps <tensor-backends>`
.. toctree::
:maxdepth: 3

Circuit Simulation <simulators.rst>
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved
Quantum Hardware (QPUs) <hardware.rst>

.. deprecated:: 0.8
The `nvidia-fp64`, `nvidia-mgpu`, `nvidia-mqpu`, and `nvidia-mqpu-fp64` targets can be
enabled as extensions of the unified `nvidia` target (see `nvidia` :ref:`target documentation <nvidia-backend>`).
These target names might be removed in a future release.
.. toctree::
:maxdepth: 1

Dynamics (dynamics) <dynamics.rst>
NVIDIA Quantum Cloud (nvqc) <nvqc.rst>
Binary file added docs/sphinx/using/backends/circuitsimulators.png
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved
mawolf2023 marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions docs/sphinx/using/backends/dynamics.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
CUDA-Q Dynamics
*********************************
Dynamics Simulation (dynamics)
+++++++++++++++++++++++++++++++

CUDA-Q enables the design, simulation and execution of quantum dynamics via
the ``evolve`` API. Specifically, this API allows us to solve the time evolution
Expand All @@ -8,7 +8,7 @@ backend target, which is based on the cuQuantum library, optimized for performan
on NVIDIA GPU.

Quick Start
+++++++++++
^^^^^^^^^^^^

In the example below, we demonstrate a simple time evolution simulation workflow comprising of the
following steps:
Expand Down Expand Up @@ -86,7 +86,7 @@ observable. Hence, we convert them into sequences for plotting purposes.


Operator
+++++++++++
^^^^^^^^^^

.. _operators:

Expand Down Expand Up @@ -157,7 +157,7 @@ The latter is specified by the dimension map that is provided to the `cudaq.evol


Time-Dependent Dynamics
++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. _time_dependent:

Expand Down Expand Up @@ -219,7 +219,7 @@ the desired value for each parameter:
:end-before: [End Schedule2]

Numerical Integrators
++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^

.. _integrators:

Expand Down Expand Up @@ -272,4 +272,4 @@ backend target.
If the output is a '`None`' string, it indicates that your Torch installation does not support CUDA.
In this case, you need to install a CUDA-enabled Torch package via other mechanisms, e.g., building Torch from source or
using their Docker images.


Loading
Loading