Skip to content

Commit

Permalink
fixing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scarrazza committed Mar 1, 2024
1 parent f3f6176 commit 5323bdc
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 46 deletions.
Binary file added doc/source/getting-started/backends.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 9 additions & 2 deletions doc/source/getting-started/backends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Qibo provides backends for quantum simulation on classical
hardware and quantum hardware management and control. In the image below we
present a schematic view of the currently supported backends.

.. image:: backends.svg
.. image:: backends.png

Quantum simulation is proposed through dedicated backends for single node
multi-GPU and multi-threading CPU setups. Quantum hardware control is supported
Expand All @@ -35,8 +35,11 @@ We provide multiple simulation backends for Qibo, which are automatically loaded
if the corresponding packages are installed, following the hierarchy below:

* :ref:`installing-qibojit`: an efficient simulation backend for CPU, GPU and multi-GPU based on just-in-time (JIT) compiled custom operators. Install this package if you need to simulate quantum circuits with large number of qubits or complex quantum algorithms which may benefit from computing parallelism.
* :ref:`installing-tensorflow`: a pure TensorFlow implementation for quantum simulation which provides access to gradient descent optimization and the possibility to implement classical and quantum architectures together. This backend is not optimized for memory and speed, use :ref:`installing-qibojit` instead.
* `qibotn <https://qibo.science/qibotn/stable/>`_: an interface to Tensor Networks simulation algorithms designed for GPUs and multi-node CPUs. This backend makes possible scaling quantum circuit simulation to a larger number of qubits.
* :ref:`installing-numpy`: a lightweight quantum simulator shipped with the :ref:`installing-qibo` base package. Use this simulator if your CPU architecture is not supported by the other backends. Please note that the simulation performance is quite poor in comparison to other backends.
* :ref:`installing-tensorflow`: a pure TensorFlow implementation for quantum simulation which provides access to gradient descent optimization and the possibility to implement classical and quantum architectures together. This backend is not optimized for memory and speed, use :ref:`installing-qibojit` instead.
* :ref:`installing-pytorch`: a pure PyTorch implementation for quantum simulation which provides access to gradient descent optimization and the possibility to implement classical and quantum architectures together. This backend is not optimized for memory and speed, use :ref:`installing-qibojit` instead.


The default backend that is used is the first available from the above list.
The user can switch to a different using the ``qibo.set_backend`` method
Expand Down Expand Up @@ -77,3 +80,7 @@ We provide the following hardware control backends for Qibo:
* `qibosoq <https://qibo.science/qibosoq/stable/>`_: is the server that
integrates `Qick <https://github.com/openquantumhardware/qick>`_ in the
Qibolab ecosystem for executing arbitrary circuits and pulse sequences.

* `qibo-cloud-backends <https://qibo.science/qibo-cloud-backends/stable/>`_:
provides access to cloud quantum hardware. This module is compatible with labs
using Qibo for control and calibration and external vendors.
6 changes: 0 additions & 6 deletions doc/source/getting-started/backends.svg

This file was deleted.

35 changes: 16 additions & 19 deletions doc/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ distributed with pypi* for the packages listed above.
+------------------+------+---------+------------+

.. note::
All packages are supported for Python >= 3.7.
All packages are supported for Python >= 3.9.


Backend installation
Expand All @@ -38,7 +38,7 @@ Installing with pip
"""""""""""""""""""

The installation using ``pip`` is the recommended approach to install Qibo.
Make sure you have Python 3.7 or greater, then use ``pip`` to install ``qibo`` with:
Make sure you have Python 3.9 or greater, then use ``pip`` to install ``qibo`` with:

.. code-block:: bash
Expand Down Expand Up @@ -237,30 +237,27 @@ please do:
_______________________

.. _docker:

Using the code with docker
--------------------------
.. _installing-pytorch:

We provide docker images for tag release of the code using GitHub Packages. The
docker images contain a pre-configured linux environment with the Qibo
framework installed with the specific tag version.
pytorch
^^^^^^^

Please refer to the download and authentication instructions from the `Qibo GitHub Packages`_.
If the `PyTorch <https://pytorch.org/>`_ package is installed Qibo
will detect and provide to the user the possibility to use ``pytorch``
backend.

In order to start the docker image in interactive mode please use docker
standard syntax, for example:
In order to switch to the ``pytorch`` backend please do:

.. code::
.. code-block:: python
docker run -it ghcr.io/qiboteam/qibo:<tag_version> bash
import qibo
qibo.set_backend("pytorch")
This will open a bash shell with the Qibo environment already activated, with
all binaries and scripts from the Qibo framework.
In order to install the package, we recommend the installation using:

.. _Qibo GitHub Packages: https://github.com/qiboteam/qibo/pkgs/container/qibo
.. code-block:: bash
pip install qibo torch
.. note::
The docker image contains the basic ``qibo`` package with the lightweight
``numpy`` backend for simulation.
_______________________
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Components

The main components of ``Qibo`` are presented in :doc:`getting-started/index`

.. image:: qibo_ecosystem.svg
.. image:: qibo_ecosystem.png

Key features
------------
Expand Down
Binary file added doc/source/qibo_ecosystem.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 0 additions & 18 deletions doc/source/qibo_ecosystem.svg

This file was deleted.

0 comments on commit 5323bdc

Please sign in to comment.