gym-dmc, OpenAI Gym Plugin for DeepMind Control Suite
Link to other OpenAI Gym Plugins:
gym-sawyer
gym-toy-nav
Update Log
2024-03-25: Return np.Array from env.render() function
2022-01-13: Add space_dtype for overriding the dtype for the state and action spaces. Default to None, need to set to float/np.float32 for pytorch_SAC implementation.
2022-01-11: Added a env._get_obs() method to allow one to obtain the observation after resetting the environment. Version: ``v0.2.1``
Installation
The dm_control dependency relies on lower versions of setuptools and wheel. Downgrade to fix the installation error.
pip install setuptools==65.5.0
pip install wheel==0.38.4
pip install gym-dmc
How To Use
Usage pattern:
import gym
env = gym.make("dmc:Pendulum-swingup-v1")
For the full list of environments, you can print:
from dm_control.suite import ALL_TASKS
print(*ALL_TASKS, sep="\n")
# Out[2]: ('acrobot', 'swingup')
# ('acrobot', 'swingup_sparse')
...
We register all of these environments using the following pattern:
acrobot task “swingup_sparse” becomes dmc:Acrobot-swingup_sparse-v1
You can see the usage pattern in https://github.com/geyang/gym_dmc/blob/master/specs/test_gym_dmc.py:
env = gym.make('dmc:Walker-walk-v1', frame_skip=4, space_dtype=np.float32)
assert env.action_space.dtype is np.float32
assert env.observation_space.dtype is np.float32
env = gym.make('dmc:Walker-walk-v1', frame_skip=4)
assert env._max_episode_steps == 250
assert env.reset().shape == (24,)
env = gym.make('dmc:Walker-walk-v1', from_pixels=True, frame_skip=4)
assert env._max_episode_steps == 250
env = gym.make('dmc:Cartpole-balance-v1', from_pixels=True, frame_skip=8)
assert env._max_episode_steps == 125
assert env.reset().shape == (3, 84, 84)
env = gym.make('dmc:Cartpole-balance-v1', from_pixels=True, frame_skip=8, channels_first=False)
assert env._max_episode_steps == 125
assert env.reset().shape == (84, 84, 3)
env = gym.make('dmc:Cartpole-balance-v1', from_pixels=True, frame_skip=8, channels_first=False, gray_scale=True)
assert env._max_episode_steps == 125
assert env.reset().shape == (84, 84, 1)
Note, the ``max_episode_steps`` is calculated based on the ``frame_skip``. All DeepMind control domains terminate after 1000 simulation steps. So for frame_skip=4, the max_episode_steps should be 250.
Built with :heart: by Ge Yang
Metadata
Release files for gym-dmc 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gym_dmc-0.3.2-py3-none-any.whl | Python 3 | none | any | Details for gym_dmc-0.3.2-py3-none-any.whl |
Release files / gym_dmc-0.3.2-py3-none-any.whl
| Download URL | gym_dmc-0.3.2-py3-none-any.whl |
|---|---|
| Size | 32.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ccf645786c25d35f11a7a0d04cf8c08fcca61293cf4900c16ac0255098e407e2
|
|
BLAKE2b-256 checksum How to use checksums |
82c9aa42163e392b5360c92ef0b815dca39aeabc58457483e1013584074035b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.8.17
|
Security for gym-dmc 0.3.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.