dodox/fancy_gym
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adding forward looking statements to README (Install instructions based on PyPI package)

Browse Source
This commit is contained in:
Dominik Moritz Roth 2023-10-23 14:24:50 +02:00
parent b183c002ef
commit b277ed6477
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -33,21 +33,23 @@ While the overarching objective of MP environments remains the learning of an op
## Installation ## Installation
We recommend installing `fancy_gym` into a virtual environments like [venv](https://docs.python.org/3/library/venv.html). 3rd party alternatives to venv like [Poetry](https://python-poetry.org/) or [Conda](https://docs.conda.io/en/latest/) can also be used.
### Installation via pip (recommended) ### Installation via pip (recommended)
While the publication of `fancy_gym` on PyPI is still pending, you can install it from Test-PyPI. Install `fancy_gym` via
```bash ```bash
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple fancy_gym pip install fancy_gym
``` ```
We have a few optional dependencies. If you also want to install those use We have a few optional dependencies. If you also want to install those use
```bash ```bash
# to install all optional dependencies # to install all optional dependencies
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple 'fancy_gym[all]' pip install 'fancy_gym[all]'
# or choose only those you want # or choose only those you want
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple 'fancy_gym[dmc,box2d,mujoco-legacy,jax,testing]' pip install 'fancy_gym[dmc,box2d,mujoco-legacy,jax,testing]'
``` ```
Pip can not automatically install up-to-date versions of metaworld, since they are not avaible on PyPI yet. Pip can not automatically install up-to-date versions of metaworld, since they are not avaible on PyPI yet.