https://github.com/allenai/ai2thor-colab
🚀 Run AI2-THOR with Google Colab
https://github.com/allenai/ai2thor-colab
ai ai2-thor computer-vision embodied-ai google-colab reinforcement-learning
Last synced: 3 months ago
JSON representation
🚀 Run AI2-THOR with Google Colab
- Host: GitHub
- URL: https://github.com/allenai/ai2thor-colab
- Owner: allenai
- License: apache-2.0
- Created: 2021-02-18T08:26:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-04T18:16:54.000Z (over 3 years ago)
- Last Synced: 2025-09-27T03:06:31.810Z (3 months ago)
- Topics: ai, ai2-thor, computer-vision, embodied-ai, google-colab, reinforcement-learning
- Language: Jupyter Notebook
- Homepage: https://ai2thor.allenai.org
- Size: 3.61 MB
- Stars: 37
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Run AI2-THOR on the Cloud using Google Colab
## 💡 Templates
#### 💪 Full Starter Template
To get started, we recommend saving a copy of the AI2-THOR Colab Full Starter Template to your drive. It goes over many helper functions that are often useful.
https://user-images.githubusercontent.com/28768645/119420726-06d8bc80-bcb2-11eb-9acf-e9b151121506.mp4
#### 👑 Minimal Starter Template
We also provide a Minimal Starter Template that does not showcase any helper functions. This is often useful as a starting point to minimally reproduce issues, highlight, or test functionality.
## 🐱💻 Setup Overview
#### 💻 Installation
Using Python's packaging manager, `ai2thor_colab` can be installed with
```python
pip install ai2thor_colab
```
#### 🔥 Start X Server
AI2-THOR requires an X Server to run on a Linux machine. It allows us to open a Unity window where we can render scenes and observe images. Colab runs Linux, but it does not start an X Server by default. Using `ai2thor_colab.start_xserver()`, we can install all required X Server dependencies and start it up:
```python
import ai2thor_colab
ai2thor_colab.start_xserver()
```
## 💬 Support
**Questions.** If you have any questions on AI2-THOR, please ask them on [AI2-THOR's GitHub Discussions Page](https://github.com/allenai/ai2thor/discussions).
**Issues.** If you encounter any issues while using AI2-THOR, please open an [Issue on AI2-THOR's GitHub](https://github.com/allenai/ai2thor/issues). If you encounter an issue with AI2-THOR Colab, please open an [Issue on our GitHub](https://github.com/allenai/ai2thor-colab/issues)
## 🏫 Learn more
| Section | Description |
| :-- | :-- |
| [AI2-THOR Website](https://ai2thor.allenai.org/) | The AI2-THOR website, which contains extensive documentation on using the API. |
| [AI2-THOR GitHub](https://github.com/allenai/ai2thor) | Contains the source code and development of AI2-THOR. |
| [AI2-THOR Demo](https://ai2thor.allenai.org/demo/) | Interact and play with AI2-THOR live in the browser. |
## 👋 Our Team
AI2-THOR and AI2-THOR Colab are open-source projects built by the [PRIOR team](//prior.allenai.org) at the [Allen Institute for AI](//allenai.org) (AI2).
AI2 is a non-profit institute with the mission to contribute to humanity through high-impact AI research and engineering.
