idrlnet/docs/user/installation.md

44 lines
821 B
Markdown
Raw Permalink Normal View History

2021-07-05 11:18:12 +08:00
# Installation
We recommend using conda to manage the environment.
Other methods may also work well such like using docker or virtual env.
2021-07-16 11:35:43 +08:00
Choose one of the following installation methods.
## PyPI
Simple installation from PyPI
```bash
pip install -U idrlnet
```
Note: To avoid version conflicts, please use some tools to create a virtual environment first.
## Docker
2021-07-18 15:22:02 +08:00
Pull latest docker image from Dockerhub.
2021-07-16 11:35:43 +08:00
```bash
docker pull idrl/idrlnet:latest
2021-07-18 15:22:02 +08:00
docker run -it idrl/idrlnet:latest bash
2021-07-16 11:35:43 +08:00
```
2021-07-18 15:22:02 +08:00
Note: Available tags can be found in [Dockerhub](https://hub.docker.com/repository/docker/idrl/idrlnet).
2021-07-05 11:18:12 +08:00
## Anaconda
```bash
conda create -n idrlnet_dev python=3.8 -y
conda activate idrlnet_dev
2021-07-16 11:35:43 +08:00
pip install idrlnet
```
## From Source
```
git clone https://github.com/idrl-lab/idrlnet
cd idrlnet
2021-07-05 11:18:12 +08:00
pip install -e .
```