Skip to content

Commit 02092ba

Browse files
committed
Fixed internal links
Signed-off-by: Eliot Heinrich <eheinrich@nvidia.com>
1 parent 905aeda commit 02092ba

3 files changed

Lines changed: 7 additions & 3 deletions

File tree

docs/sphinx/api/qec/tensor_network_decoder_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
decoder. Use `pip install cudaq-qec[tensor-network-decoder]` in order to use
1414
this decoder.
1515

16-
The Tensor Network Decoder has the same GPU support as the `Quantum Low-Density Parity-Check Decoder <https://nvidia.github.io/cudaqx/components/qec/decoders.html#quantum-low-density-parity-check-decoder>`__.
16+
The Tensor Network Decoder has the same GPU support as the :ref:`Quantum Low-Density Parity-Check Decoder <qldpc_decoder>`.
1717
However, if you are using the V100 GPU (SM70), you will need to pin your
1818
cuTensor version to 2.2 by running `pip install cutensor_cu12==2.2`. Note
1919
that this GPU is not supported by the Tensor Network Decoder.

docs/sphinx/components/qec/decoders.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,8 @@ In Python, the ``backend`` parameter (``"auto"``, ``"gpu"``, or ``"cpu"``) contr
268268
For a complete, runnable walkthrough — including GPU acceleration and input-type handling — see the :ref:`DEM Sampling example <dem_sampling_example>`.
269269

270270

271+
.. _prebuilt_qec_decoders:
272+
271273
Pre-built QEC Decoders
272274
----------------------
273275

@@ -332,6 +334,8 @@ CUDA-Q QEC provides pre-built decoders for a variety of use cases.
332334
333335
Here's a detailed overview of each:
334336

337+
.. _qldpc_decoder:
338+
335339
Quantum Low-Density Parity-Check Decoder
336340
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
337341

@@ -471,7 +475,7 @@ The decoder returns the probability that the logical observable has flipped for
471475
.. note::
472476

473477
In general, the Tensor Network Decoder has the same GPU support as the
474-
`Quantum Low-Density Parity-Check Decoder <https://nvidia.github.io/cudaqx/components/qec/decoders.html#quantum-low-density-parity-check-decoder>`__.
478+
:ref:`Quantum Low-Density Parity-Check Decoder <qldpc_decoder>`.
475479
However, if you are using the V100 GPU (SM70), you will need to pin your
476480
cuTensor version to 2.2 by running `pip install cutensor_cu12==2.2`. Note
477481
that this GPU will not be supported by the Tensor Network Decoder when

docs/sphinx/examples_rst/qec/getting_started_realtime_decoding.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,7 @@ They are valid both for python and C++ applications, however, they must be set b
625625

626626
Decoder Selection
627627
^^^^^^^^^^^^^^^^^
628-
The page `CUDA-Q QEC Decoders <https://nvidia.github.io/cudaqx/components/qec/decoders.html#pre-built-qec-decoders>`_ provides information about which decoders are compatible with realtime decoding.
628+
The :ref:`Pre-built QEC Decoders <prebuilt_qec_decoders>` section provides information about which decoders are compatible with realtime decoding.
629629

630630
The TRT decoder (``trt_decoder``) can be configured for realtime decoding by specifying
631631
its ``decoder_custom_args`` parameters. This is useful for neural network-based

0 commit comments

Comments
 (0)