Docker Instructions (zhanghang1989#308)

* avoid network error * add docker instructions * typo Co-authored-by: hzaws <hzaws@u8aedb6e0b0c250.ant.amazon.com>
BrandonHanx · Aug 4, 2020 · f46bcf7 · f46bcf7
1 parent deec6de
commit f46bcf7
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/source/notes/compile.rst b/docs/source/notes/compile.rst
@@ -17,6 +17,22 @@ Installation
         python setup.py install
 
 
+Using Docker
+------------
+
+We strongly recommend using the docker option, if you are experiencing any errors using standard installation.
+
+    * Install Docker Engine by following the `Install Docker Engine <https://docs.docker.com/engine/install/>`_.
+    * Build the docker image::
+
+        git clone https://github.com/zhanghang1989/PyTorch-Encoding && cd PyTorch-Encoding
+        bash scripts/build_docker.sh
+
+    * Run the docker::
+
+        bash scripts/run_docker.sh
+
+
 Detailed Steps
 --------------
 

diff --git a/scripts/build_docker.sh b/scripts/build_docker.sh
@@ -1 +1 @@
-docker build -t encoding .
+docker build --network=host -t encoding .