Skip to content

Commit b6d4985

Browse files
update docs
1 parent 856cf8e commit b6d4985

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/source/faq.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ How can I use multiple GPUs?
4141
For different observables evaluation on different cards, see `example <https://github.com/tensorcircuit/tensorcircuit-ng/blob/master/examples/vqe_parallel_pmap.py>`_.
4242

4343
For distributed simulation of one circuit on multiple cards, see `example for expectation <https://github.com/tensorcircuit/tensorcircuit-ng/blob/master/examples/slicing_auto_pmap_vqa.py>`_ and `example for MPO <https://github.com/tensorcircuit/tensorcircuit-ng/blob/master/examples/slicing_auto_pmap_mpo.py>`_.
44+
We also introduce a new interface for the multi-GPU tensornetwork contraction, see `example for VQE <https://github.com/tensorcircuit/tensorcircuit-ng/blob/master/examples/distributed_interface_vqe.py>`_ and `example for ammplitude <https://github.com/tensorcircuit/tensorcircuit-ng/blob/master/examples/distributed_interface_amplitude.py>`_.
4445

4546

4647
When should I jit the function?

docs/source/quickstart.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,25 @@ Installation
1010
``pip install tensorcircuit-ng``
1111

1212
is in general enough.
13-
Either pip from conda or other python env managers is fine.
1413

1514
Since there are many optional packages for various features,
16-
the users may need to install more pip packages when required.
15+
the users may need to install more packages by pip when required.
1716

1817
For Nvidia GPU,
1918
please refer to the GPU aware installation guide of corresponding machine learning frameworks:
20-
`TensorFlow <https://www.tensorflow.org/install/gpu>`_,
21-
`Jax <https://github.com/google/jax#pip-installation-gpu-cuda>`_,
19+
`TensorFlow <https://www.tensorflow.org/install/pip>`_ (``pip install 'tensorflow[and-cuda]'``),
20+
`Jax <https://docs.jax.dev/en/latest/installation.html#pip-installation-nvidia-gpu-cuda-installed-via-pip-easier>`_ (``pip install 'jax[cuda-12]'``),
2221
or `PyTorch <https://pytorch.org/get-started/locally/>`_.
2322

24-
Docker is also recommended (especially Linux + Nvidia GPU setup):
23+
Docker is also accessible:
2524

2625
``sudo docker run -it --network host --gpus all tensorcircuit/tensorcircuit``.
2726

2827
For more details on docker setup, please refer to `docker readme <https://github.com/tensorcircuit/tensorcircuit-ng/tree/master/docker>`_.
2928

3029

31-
Overall, the installation of TensorCircuit-NG is simple, since it is purely in Python and hence very portable.
32-
As long as the users can take care of the installation of ML frameworks on the corresponding system, TensorCircuit-NG will work as expected.
30+
Overall, the installation of TensorCircuit-NG is simple, since it is purely in Python and hence portable.
31+
As long as the users can take care of the installation of ML frameworks on the corresponding operating system, TensorCircuit-NG will work as expected.
3332

3433
To debug the installation issue or report bugs, please check the environment information by ``tc.about()``.
3534

@@ -218,7 +217,7 @@ If the user has no intention to maintain the application code in a backend agnos
218217
Automatic Differentiation, JIT, and Vectorized Parallelism
219218
-------------------------------------------------------------
220219

221-
For concepts of AD, JIT and VMAP, please refer to `Jax documentation <https://jax.readthedocs.io/en/latest/jax-101/index.html>`__ .
220+
For concepts of AD, JIT and VMAP, please refer to `Jax documentation <https://docs.jax.dev/en/latest/tutorials.html>`__ .
222221

223222
The related API design in TensorCircuit-NG closely follows the functional programming design pattern in Jax with some slight differences. So we strongly recommend users learn some basics about Jax no matter which ML backend they intend to use.
224223

0 commit comments

Comments
 (0)