A library for reinforcement learning environments in the field of planar robotics
Project description
Gymnasium-Planar-Robotics (GymPR)
This library contains reinforcement learning environments for motion planning and object manipulation in the field of planar robotics. The environments follow either the Gymnasium API for single-agent RL or the PettingZoo parallel API for multi-agent RL. All environments are based on the MuJoCo physics engine. Note that this library depends on the latest MuJoCo Python bindings. mujoco-py is not supported.
Installation
The Gymnasium-Planar-Robotics package can be installed via PIP:
pip install gymnasium-planar-robotics
To install optional dependencies, to build the documentation, or to run the tests, use:
pip install gymnasium-planar-robotics[docs, tests]
Note: Depending on your shell (e.g. when using Zsh), you may need to use additional quotation marks:
pip install "gymnasium-planar-robotics[docs, tests]"
Documentation
The documentation is available at: https://ubi-coro.github.io/gymnasium-planar-robotics/
License
GymPR is published under the GNU General Public License v3.0.
Example
The following example shows how to use a trained policy with an example environment that follows the Gymnasium API:
import gymnasium as gym
env = gym.make("BenchmarkPushingEnv-v0", render_mode="human")
observation, info = env.reset(seed=42)
for _ in range(0,100):
while not terminated and not truncated:
action = policy(observation) # custom policy
observation, reward, terminated, truncated, info = env.step(action)
observation, info = env.reset()
env.close()
Maintainer
Gymnasium-Planar-Robotics is currently maintained by Lara Bergmann (@lbergmann1).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gymnasium_planar_robotics-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 961d2c7d7a7bd14a40f038d403b546aa8ca65046d5db5990369dfcd38c93fb7d |
|
MD5 | 44930744f3d537af64ff904c39ea7997 |
|
BLAKE2b-256 | 15b2f342ecefb3478bd860e9449a64965b17fd0aa701c7804681be3ffbfe6378 |
Hashes for gymnasium_planar_robotics-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45906adf386783b1bba4e79d901a6e37770050b3c1f9399eba3c62d1fb06ed6a |
|
MD5 | 5f5851c8b12208208324be964f1679af |
|
BLAKE2b-256 | 3fc6d4cae505c2afc83347f7a74a37ebbd62b36924027414fe10a9100634b8da |