Skip to content

Commit 06b09ca

Browse files
committed
Update docker and install docs
1 parent 8cc7bf9 commit 06b09ca

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/docker.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Downloading Docker Image From Docker Hub
2323

2424
.. code-block:: bash
2525
26-
sudo docker pull bluefoglib/bluefog:gpu-0.2.1
26+
sudo docker pull bluefoglib/bluefog:gpu-0.2.2
2727
2828
2. Download docker image with only CPU support:
2929

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

5858
.. code-block:: bash
5959
60-
sudo docker run --privileged -it --gpus all --name bluefog_gpu_deploy --network=host -v /mnt/share/ssh:/root/.ssh bluefog_gpu:latest
60+
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
6161
6262
2. Run docker container with only CPU support:
6363

@@ -114,4 +114,4 @@ The docker images have already included a few examples for the Bluefog library a
114114
115115
.. code-block:: bash
116116
117-
bfrun -np 4 python examples/pytorch_average_consensus.py
117+
bfrun -np 4 python examples/pytorch_mnist.py

docs/install.rst

+8-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ After you think the environment is all set, just run following command to instal
2222
2323
pip install --no-cache-dir bluefog
2424
25+
.. Note::
26+
27+
We haven't fully tested our compatiblity with hisotrical torch versions.
28+
It is guaranteed at least for ``torch==1.4.0`` and ``torchvision==0.5.0`` case.
29+
Remember if the torch version is changed, you have to re-install bluefog completely.
30+
2531
.. Note::
2632

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

8187
.. code-block:: bash
8288
83-
sudo docker pull bluefoglib/bluefog:gpu
89+
sudo docker pull bluefoglib/bluefog:gpu-0.2.2
8490
8591
2. Download docker image with only CPU support:
8692

8793
.. code-block:: bash
8894
89-
sudo docker pull bluefoglib/bluefog:cpu
95+
sudo docker pull bluefoglib/bluefog:cpu-0.2.2
9096
9197
.. _conda: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
9298
.. _download link: https://www.open-mpi.org/software/ompi/v4.0/

0 commit comments

Comments
 (0)