├── Dockerfile ├── LICENSE ├── README.md ├── doc └── static │ └── thor-logo-main_1.0_thick.png ├── example_agent.py ├── requirements.txt ├── requirements_dev.txt ├── scripts ├── build.sh ├── install_nvidia.sh └── run.sh └── tasks.py /Dockerfile: -------------------------------------------------------------------------------- 1 | ARG CUDA_VERSION 2 | 3 | FROM nvidia/cuda:$CUDA_VERSION-devel-ubuntu18.04 4 | ARG NVIDIA_VERSION 5 | 6 | ENV DEBIAN_FRONTEND=noninteractive 7 | RUN apt-get update && apt-get -y install python3-pip libvulkan1 python3-venv vim pciutils wget git kmod vim git 8 | 9 | ENV APP_HOME /app 10 | WORKDIR $APP_HOME 11 | COPY requirements.txt scripts/install_nvidia.sh /app/ 12 | RUN pip3 install --upgrade pip 13 | 14 | RUN pip3 install -r requirements.txt && python3 -c "import os; import ai2thor.build; ai2thor.build.Build('CloudRendering', ai2thor.build.DEFAULT_CLOUDRENDERING_COMMIT_ID, False, releases_dir=os.path.join(os.path.expanduser('~'), '.ai2thor/releases')).download()" 15 | RUN NVIDIA_VERSION=$NVIDIA_VERSION /app/install_nvidia.sh 16 | 17 | COPY example_agent.py ./ 18 | 19 | CMD ["/bin/bash"] 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

4 | 5 | -------------------------------------------------------------------------------- 6 | 7 | # AI2-THOR Docker 8 | 9 | AI2-THOR Docker is a mini-framework that simplifies the task of running [AI2-THOR](https://ai2thor.allenai.org) within Docker. The primary feature this adds is configuring and running a X server to be used by Unity3d to render scenes. 10 | 11 | ## Getting Started 12 | 13 | To use AI2-THOR Docker you must have Docker installed on your host and a Nvidia GPU (required for 3D rendering). 14 | 15 | 16 | 1. Clone or fork this repository. 17 | 18 | ```bash 19 | git clone https://github.com/allenai/ai2thor-docker 20 | ``` 21 | 22 | 2. Build the Docker container. 23 | 24 | ``` 25 | cd ai2thor-docker 26 | ./scripts/build.sh 27 | ``` 28 | 29 | 3. Run the example agent using Docker. 30 | 31 | ``` 32 | ./scripts/run.sh 33 | ``` 34 | 35 | At this point you should see output that resembles the following: 36 | ``` 37 | 38 | PlayerPrefs - Creating folder: /root/.config/unity3d/Allen Institute for Artificial Intelligence 39 | PlayerPrefs - Creating folder: /root/.config/unity3d/Allen Institute for Artificial Intelligence/AI2-Thor 40 | Logging to /root/.config/unity3d/Allen Institute for Artificial Intelligence/AI2-Thor/Player.log 41 | Initialize return: {'cameraNearPlane': 0.1, 'cameraFarPlane': 20.0} 42 | {'cameraHorizon': 0.0, 43 | 'inHighFrictionArea': False, 44 | 'isStanding': True, 45 | 'name': 'agent', 46 | 'position': {'x': -1.5, 'y': 0.9009982347488403, 'z': -1.5}, 47 | 'rotation': {'x': 0.0, 'y': 270.0, 'z': 0.0}} 48 | ``` 49 | 50 | ## Docker 51 | 52 | The Docker container is built with the highest version of CUDA that the host version's Nvidia driver will support. In order to train/execute a model the code must either be explicitly copied into the container by adding an entry into the Dockerfile or by sharing a volume with your code to the container (see ./scripts/run.sh). 53 | 54 | ## Example 55 | 56 | The following is code for the example agent that executes a single command ```RotateRight```. 57 | 58 | ```python 59 | from pprint import pprint 60 | import ai2thor.controller 61 | 62 | 63 | if __name__ == '__main__': 64 | controller = ai2thor.controller.Controller(scene='FloorPlan28') 65 | event = controller.step(action='RotateRight') 66 | pprint(event.metadata['agent']) 67 | 68 | ``` 69 | 70 | -------------------------------------------------------------------------------- /doc/static/thor-logo-main_1.0_thick.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/allenai/ai2thor-docker/dce8f9c5612032799e9640f3871a7257530bd654/doc/static/thor-logo-main_1.0_thick.png -------------------------------------------------------------------------------- /example_agent.py: -------------------------------------------------------------------------------- 1 | import ai2thor.controller 2 | import ai2thor.platform 3 | from pprint import pprint 4 | 5 | 6 | if __name__ == '__main__': 7 | controller = ai2thor.controller.Controller(platform=ai2thor.platform.CloudRendering, scene='FloorPlan28') 8 | event = controller.step(action='RotateRight') 9 | pprint(event.metadata['agent']) 10 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | ai2thor 2 | -------------------------------------------------------------------------------- /requirements_dev.txt: -------------------------------------------------------------------------------- 1 | invoke 2 | boto3 3 | -------------------------------------------------------------------------------- /scripts/build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | if [ ! -e /proc/driver/nvidia/version ]; then 3 | echo "Error: Nvidia driver not found at /proc/driver/nvidia/version; Please ensure you have an Nvidia GPU device and appropriate drivers are installed." 4 | exit 1; 5 | fi; 6 | 7 | if ! type "docker" 2> /dev/null > /dev/null ; then 8 | echo "Error: docker not found. Please install docker to complete the build. " 9 | exit 1 10 | fi; 11 | 12 | NVIDIA_VERSION=`cat /proc/driver/nvidia/version | grep 'NVRM version:'| grep -oE "Kernel Module\s+[0-9.]+"| awk {'print $3'}` 13 | NVIDIA_MAJOR=`echo $NVIDIA_VERSION | tr "." "\n" | head -1 | tr -d "\n"` 14 | NVIDIA_MINOR=`echo $NVIDIA_VERSION | tr "." "\n" | head -2 | tail -1| tr -d "\n"` 15 | 16 | # https://docs.nvidia.com/deploy/cuda-compatibility/index.html#binary-compatibility__table-toolkit-driver 17 | if (( $NVIDIA_MAJOR >= 470 && $NVIDIA_MINOR >= 42 )); then 18 | CUDA_VERSION=11.4.2 19 | elif (( $NVIDIA_MAJOR >= 465 && $NVIDIA_MINOR >= 19 )); then 20 | CUDA_VERSION=11.3.1 21 | elif (( $NVIDIA_MAJOR >= 460 && $NVIDIA_MINOR >= 27 )); then 22 | CUDA_VERSION=11.2.2 23 | elif (( $NVIDIA_MAJOR >= 450 && $NVIDIA_MINOR >= 80 )); then 24 | CUDA_VERSION=11.1 25 | elif (( $NVIDIA_MAJOR >= 450 && $NVIDIA_MINOR >= 36 )); then 26 | CUDA_VERSION=11.0 27 | elif (( $NVIDIA_MAJOR >= 440 && $NVIDIA_MINOR >= 33 )); then 28 | CUDA_VERSION=10.2 29 | elif (( $NVIDIA_MAJOR >= 418 && $NVIDIA_MINOR >= 39 )); then 30 | CUDA_VERSION=10.1 31 | elif (( $NVIDIA_MAJOR >= 410 && $NVIDIA_MINOR >= 48 )); then 32 | CUDA_VERSION=10.0 33 | elif (( $NVIDIA_MAJOR >= 396 && $NVIDIA_MINOR >= 26 )); then 34 | CUDA_VERSION=9.2 35 | elif (( $NVIDIA_MAJOR >= 390 && $NVIDIA_MINOR >= 46 )); then 36 | CUDA_VERSION=9.1 37 | elif (( $NVIDIA_MAJOR >= 384 && $NVIDIA_MINOR >= 81 )); then 38 | CUDA_VERSION=9.0 39 | else 40 | echo "No valid CUDA version found for nvidia driver $NVIDIA_VERSION" 41 | exit 1 42 | fi 43 | 44 | 45 | if (id -nG | grep -qw "docker") || [ "$USER" == "root" ]; then 46 | echo "Building Docker container with CUDA Version: $CUDA_VERSION, NVIDIA Driver: $NVIDIA_VERSION" 47 | docker build --build-arg NVIDIA_VERSION=$NVIDIA_VERSION --build-arg CUDA_VERSION=$CUDA_VERSION -t ai2thor-docker:latest . 48 | else 49 | echo "Error: Unable to run build.sh. Please use sudo to run build.sh or add $USER to the docker group." 50 | exit 1 51 | fi 52 | 53 | -------------------------------------------------------------------------------- /scripts/install_nvidia.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | nvidia_version=`cat /proc/driver/nvidia/version |grep 'NVRM version:'| grep -oE "Kernel Module\s+[0-9.]+"| awk {'print $3'}` 3 | nvidia_major_version=`echo $nvidia_version |sed "s/\..*//"` 4 | driver_filename="NVIDIA-Linux-x86_64-$nvidia_version.run" 5 | driver_url="http://us.download.nvidia.com/XFree86/Linux-x86_64/$nvidia_version/$driver_filename" 6 | tesla_driver_url="http://us.download.nvidia.com/tesla/$nvidia_version/$driver_filename" 7 | s3_driver_url="http://ai2-vision-nvidia.s3-us-west-2.amazonaws.com/$driver_filename" 8 | wget $driver_url -P /tmp/ || wget $tesla_driver_url -P /tmp/ || wget $s3_driver_url -P /tmp/ 9 | 10 | if [ $? -eq 0 ]; then 11 | sh /tmp/$driver_filename -s --no-kernel-module 12 | else 13 | echo "Error trying to install nvidia driver for $nvidia_version" 14 | exit 1 15 | fi; 16 | -------------------------------------------------------------------------------- /scripts/run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) 3 | cd $DIR/../ 4 | 5 | export ROBOTHOR_BASE_DIR=`pwd` 6 | docker run --rm -it ai2thor-docker:latest python3 example_agent.py 7 | -------------------------------------------------------------------------------- /tasks.py: -------------------------------------------------------------------------------- 1 | from invoke import task 2 | import boto3 3 | import subprocess 4 | import os 5 | import glob 6 | import tempfile 7 | import platform 8 | 9 | 10 | @task 11 | def extract_store_nvidia_driver(context, cuda_url): 12 | if platform.system() != "Linux": 13 | raise Exception("CUDA driver extraction can only be run on Linu") 14 | 15 | name = os.path.basename(cuda_url) 16 | subprocess.run("wget -O '%s' '%s'" % (name, cuda_url), shell=True) 17 | os.chmod(name, 0o755) 18 | with tempfile.TemporaryDirectory() as tf_name: 19 | subprocess.check_call("./%s --extract=%s" % (name, tf_name), shell=True) 20 | drivers = list(glob.glob('%s/NVIDIA-Linux-x86_64-*.run' % tf_name)) 21 | if drivers: 22 | driver_path = drivers[0] 23 | print("Storing driver %s at s3://ai2thor-vision-nvidia" % driver_path) 24 | with open(driver_path, "rb") as f: 25 | data = f.read() 26 | 27 | key = os.path.basename(driver_path) 28 | 29 | s3 = boto3.resource("s3") 30 | s3.Object('ai2-vision-nvidia', key).put( 31 | Body=data, ACL="public-read", ContentType="text/x-shellscript" 32 | ) 33 | else: 34 | raise Exception("no drivers found in %s" % name) 35 | 36 | os.unlink(name) 37 | --------------------------------------------------------------------------------