Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Deathn0t committed Aug 25, 2023
1 parent 5a576e0 commit 32b9e62
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 11 deletions.
3 changes: 2 additions & 1 deletion docs/install/pip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ DeepHyper supports distributed computation with different backends. ``MPI`` demo
$ pip install "deephyper[mpi]" # Install MPI features for MPICommEvaluator.
$ pip install "deephyper[ray]" # Install Ray features for RayEvaluator.
$ pip install "deephyper[redis]" # Install Redis Client for RedisStorage with Distributed Search.
$ pip install "deephyper[redis-hiredis]" # Install Redis with Hiredis for better performance.
For ``Redis`` we advice to follow the `Redis official installation guide <https://redis.io/topics/quickstart>`_ to install the client/server features. Then, the ``RedisJson`` also needs to be installed by following the `Redis JSON official installation guide <https://redis.io/docs/stack/json/>`_.
For ``Redis`` we advice to follow the `Redis official installation guide <https://redis.io/topics/quickstart>`_ to install the client/server features. Then, the ``RedisJson`` also needs to be installed by following the `Redis JSON official installation guide <https://redis.io/docs/stack/json/>`_. To make the installation easier we provide a Spack package ``redisjson`` for which installation instruction are detailed at :ref:`Redis Server Install`.

For ``MPI`` we advice to follow the `MPI official installation guide <https://www.open-mpi.org/faq/?category=building>`_ to install the client/server features. But, in many centers an ``MPI`` installation will already be provided or it can also be installed through a package manager (e.g., ``apt`` or ``brew``).
42 changes: 32 additions & 10 deletions docs/install/spack.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Spack
*****

`Spack <https://spack.readthedocs.io/en/latest/>`_ is a package management tool designed to support multiple versions and configurations of software on a wide variety of platforms and environments.

`Spack <https://spack.readthedocs.io/en/latest/>`_ is a package management tool designed to support multiple versions and configurations of software on a wide variety of platforms and environments. We use Spack to build from source some dependencies of DeepHyper.

Start by installing Spack on your system. The following command will install Spack in the current directory:

Expand All @@ -11,25 +10,48 @@ Start by installing Spack on your system. The following command will install Spa
$ git clone -c feature.manyFiles=true https://github.com/spack/spack.git
$ . ./spack/share/spack/setup-env.sh
Download the deephyper Spack package repository:
.. _Redis Server Install:

Redis Server & RedisJSON
========================

Create a Spack environment where the redis-server will be installed:

.. code-block:: console
$ spack env create redisjson
$ spack env activate redisjson
Download the deephyper Spack package repository and add it to the environment:

.. code-block:: console
$ git clone https://github.com/deephyper/deephyper-spack-packages.git
$ spack repo add deephyper-spack-packages
Create a new environment for DeepHyper:
Then, add the ``redisjson`` Spack package to the environment:

.. code-block:: console
$ spack env create deephyper
$ spack env activate deephyper
$ spack add redisjson
Finally, install:

.. code-block:: console
$ spack install
$ spack install py-deephyper
$ spack load py-deephyper
Now that the Redis server is installed and the RedisJSON pluging is compiled you can start the Redis server using the appropriate ``redis.conf``. The following commands will create a ``redis.conf`` file which configures the server to listen on all interfaces, and also load the RedisJSON plugin:

.. code-block:: console
.. warning::
$ touch redis.conf
$ echo "bind 0.0.0.0" >> redis.conf
$ cat $(spack find --path redisjson | grep -o "/.*/redisjson.*")/redis.conf >> redis.conf
Finally, start the Redis server:

.. code-block:: console
The Spack installation will only provide the default DeepHyper installation (i.e., hyperparameter optimization). All features will not be included by default.
$ redis-server redis.conf

0 comments on commit 32b9e62

Please sign in to comment.