Skip to content

Commit

Permalink
Update docker and install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bichengying committed Nov 7, 2020
1 parent 8cc7bf9 commit 06b09ca
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Downloading Docker Image From Docker Hub

.. code-block:: bash
sudo docker pull bluefoglib/bluefog:gpu-0.2.1
sudo docker pull bluefoglib/bluefog:gpu-0.2.2
2. Download docker image with only CPU support:

.. code-block:: bash
sudo docker pull bluefoglib/bluefog:cpu-0.2.1
sudo docker pull bluefoglib/bluefog:cpu-0.2.2
Building Your Own Docker Image
##############################
Expand Down Expand Up @@ -57,7 +57,7 @@ if you download the docker image from `Docker Hub <https://hub.docker.com/r/blue

.. code-block:: bash
sudo docker run --privileged -it --gpus all --name bluefog_gpu_deploy --network=host -v /mnt/share/ssh:/root/.ssh bluefog_gpu:latest
sudo docker run --privileged -it --gpus all --name bluefog_gpu_deploy --shm-size=64g --network=host -v /mnt/share/ssh:/root/.ssh bluefog_gpu:latest
2. Run docker container with only CPU support:

Expand Down Expand Up @@ -114,4 +114,4 @@ The docker images have already included a few examples for the Bluefog library a
.. code-block:: bash
bfrun -np 4 python examples/pytorch_average_consensus.py
bfrun -np 4 python examples/pytorch_mnist.py
10 changes: 8 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ After you think the environment is all set, just run following command to instal
pip install --no-cache-dir bluefog
.. Note::

We haven't fully tested our compatiblity with hisotrical torch versions.
It is guaranteed at least for ``torch==1.4.0`` and ``torchvision==0.5.0`` case.
Remember if the torch version is changed, you have to re-install bluefog completely.

.. Note::

If ``--no-cache-dir`` is not present, you may receive the error information like
Expand Down Expand Up @@ -80,13 +86,13 @@ For more details, check :ref:`Docker Usage` page.

.. code-block:: bash
sudo docker pull bluefoglib/bluefog:gpu
sudo docker pull bluefoglib/bluefog:gpu-0.2.2
2. Download docker image with only CPU support:

.. code-block:: bash
sudo docker pull bluefoglib/bluefog:cpu
sudo docker pull bluefoglib/bluefog:cpu-0.2.2
.. _conda: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
.. _download link: https://www.open-mpi.org/software/ompi/v4.0/
Expand Down

0 comments on commit 06b09ca

Please sign in to comment.