Add docker installation docs. (#17)

README.md

@@ -26,7 +26,8 @@
     <a href="https://cupy.dev/"><img alt="cupy" src="https://img.shields.io/badge/-Cupy-46C02B?logo=numpy&logoColor=white"></a>
     <a href="https://twitter.com/yuliangxiu"><img alt='Twitter' src="https://img.shields.io/twitter/follow/yuliangxiu?label=%40yuliangxiu"></a>
     <br></br>
-     <a href='https://colab.research.google.com/drive/1YRgwoRCZIrSB2e7auEWFyG10Xzjbrbno?usp=sharing' style='padding-left: 0.5rem;'><img src='https://colab.research.google.com/assets/colab-badge.svg' alt='Google Colab'></a><br></br>
+    <a href='https://colab.research.google.com/drive/1YRgwoRCZIrSB2e7auEWFyG10Xzjbrbno?usp=sharing'><img src='https://colab.research.google.com/assets/colab-badge.svg' alt='Google Colab'></a>
+    <a href='https://github.com/YuliangXiu/ECON/blob/master/docs/installation-docker.md'><img src='https://img.shields.io/badge/Run%20the%20Docker-9cf.svg?logo=Docker' alt='Docker'></a><br></br>
     <a href="https://arxiv.org/abs/2212.07422">
       <img src='https://img.shields.io/badge/Paper-PDF-green?style=for-the-badge&logo=adobeacrobatreader&logoWidth=20&logoColor=white&labelColor=66cc00&color=94DD15' alt='Paper PDF'>
     </a>
@@ -45,8 +46,8 @@ ECON is designed for "Human digitization from a color image", which combines the
 
 ## News :triangular_flag_on_post:
 
-- [2023/01/06] [Justin John](https://github.com/justinjohn0306) and [
-Carlos Barreto](https://github.com/carlosedubarreto) creates [install-on-windows](docs/installation-windows.md) for ECON .
+- [2023/01/08] [Teddy Huang](https://github.com/Teddy12155555) creates [install-with-docker](docs/installation-docker.md) for ECON .
+- [2023/01/06] [Justin John](https://github.com/justinjohn0306) and [Carlos Barreto](https://github.com/carlosedubarreto) creates [install-on-windows](docs/installation-windows.md) for ECON .
 - [2022/12/22] <a href='https://colab.research.google.com/drive/1YRgwoRCZIrSB2e7auEWFyG10Xzjbrbno?usp=sharing' style='padding-left: 0.5rem;'><img src='https://colab.research.google.com/assets/colab-badge.svg' alt='Google Colab'></a> is now available, created by [Aron Arzoomand](https://github.com/AroArz).
 - [2022/12/15] Both <a href="#demo">demo</a> and <a href="https://arxiv.org/abs/2212.07422">arXiv</a> are available.
 
@@ -80,6 +81,7 @@ Carlos Barreto](https://github.com/carlosedubarreto) creates [install-on-windows
 
 ## Instructions
 
+- See [installion doc for Docker](docs/installation-docker.md) to run a docker container with pre-built image for ECON demo
 - See [installion doc for Windows](docs/installation-windows.md) to install all the required packages and setup the models on _Windows_
 - See [installion doc for Ubuntu](docs/installation-ubuntu.md) to install all the required packages and setup the models on _Ubuntu_
 - See [magic tricks](docs/tricks.md) to know a few technical tricks to further improve and accelerate ECON
@@ -152,7 +154,6 @@ Some images used in the qualitative examples come from [pinterest.com](https://w
 
 This project has received funding from the European Union’s Horizon 2020 research and innovation programme under the Marie Skłodowska-Curie grant agreement No.860768 ([CLIPE Project](https://www.clipe-itn.eu)).
 
-
 ## Contributors
 
 Kudos to all of our amazing contributors! ECON thrives through open-source. In that spirit, we welcome all kinds of contributions from the community.

docker-compose.yaml

@@ -0,0 +1,19 @@
+# build Image from Docker Hub
+version: "2.4"
+services:
+  econ:
+    container_name: econ-container
+    image: teddy12155555/econ:v1
+    runtime: nvidia
+    environment:
+      - NVIDIA_VISIBLE_DEVICES=all
+      - DISPLAY=${DISPLAY}
+    stdin_open: true
+    tty: true
+    volumes:
+      - .:/root/code
+      - /tmp/.X11-unix:/tmp/.X11-unix
+    ports:
+      - "8000:8000"
+    privileged: true
+    command: "bash"

docs/installation-docker.md

@@ -0,0 +1,80 @@
+## Getting started
+
+Start by cloning the repo:
+
+```bash
+git clone --depth 1 git@github.com:YuliangXiu/ECON.git
+cd ECON
+```
+## Environment
+- **GPU Memory > 12GB**
+
+start with [docker compose](https://docs.docker.com/compose/)
+```bash
+# you can change your container name by passing --name "parameter" 
+docker compose run [--name myecon] econ
+```
+
+## Docker container's shell
+```bash
+# activate the pre-build env
+cd code
+conda activate econ
+
+# install libmesh & libvoxelize
+cd lib/common/libmesh
+python setup.py build_ext --inplace
+cd ../libvoxelize
+python setup.py build_ext --inplace
+```
+
+## Register at [ICON's website](https://icon.is.tue.mpg.de/)
+
+![Register](../assets/register.png)
+Required:
+
+- [SMPL](http://smpl.is.tue.mpg.de/): SMPL Model (Male, Female)
+- [SMPL-X](http://smpl-x.is.tue.mpg.de/): SMPL-X Model, used for training
+- [SMPLIFY](http://smplify.is.tue.mpg.de/): SMPL Model (Neutral)
+- [PIXIE](https://icon.is.tue.mpg.de/user.php): PIXIE SMPL-X estimator
+
+:warning: Click **Register now** on all dependencies, then you can download them all with **ONE** account.
+
+## Downloading required models and extra data
+
+```bash
+cd ~/code
+bash fetch_data.sh # requires username and password
+```
+## :whale2: **todo**
+- **Image Environment Infos**
+    - Ubuntu 18
+    - CUDA = 11.3
+    - Python = 3.8
+- [X] pre-built image with docker compose
+- [ ] docker run command, Dockerfile
+- [ ] verify on WSL (Windows)
+
+## Citation
+
+:+1: Please consider citing these awesome HPS approaches: PyMAF-X, PIXIE
+
+
+```
+@article{pymafx2022,
+  title={PyMAF-X: Towards Well-aligned Full-body Model Regression from Monocular Images},
+  author={Zhang, Hongwen and Tian, Yating and Zhang, Yuxiang and Li, Mengcheng and An, Liang and Sun, Zhenan and Liu, Yebin},
+  journal={arXiv preprint arXiv:2207.06400},
+  year={2022}
+}
+
+
+@inproceedings{PIXIE:2021,
+  title={Collaborative Regression of Expressive Bodies using Moderation},
+  author={Yao Feng and Vasileios Choutas and Timo Bolkart and Dimitrios Tzionas and Michael J. Black},
+  booktitle={International Conference on 3D Vision (3DV)},
+  year={2021}
+}
+
+
+```