From f46bcf7f5846e3c80a2c2abe0f40a481a9fe8c1f Mon Sep 17 00:00:00 2001 From: Hang Zhang Date: Tue, 4 Aug 2020 21:38:48 +0000 Subject: [PATCH] Docker Instructions (#308) * avoid network error * add docker instructions * typo Co-authored-by: hzaws --- docs/source/notes/compile.rst | 16 ++++++++++++++++ scripts/build_docker.sh | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/source/notes/compile.rst b/docs/source/notes/compile.rst index aa6bab11..2da503db 100644 --- 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 `_. + * 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 index f60adf29..95bc811e 100644 --- a/scripts/build_docker.sh +++ b/scripts/build_docker.sh @@ -1 +1 @@ -docker build -t encoding . +docker build --network=host -t encoding .