Skip to main content

A toolkit for developing OpenAI Gym environments simulated with Ignition Gazebo.

Project description

gym-ignition

Description

gym-ignition is a framework to create reproducible robotics environments for reinforcement learning research.

It is based on the ScenarIO project which provides the low-level APIs to interface with the Ignition Gazebo simulator. By default, RL environments share a lot of boilerplate code, e.g. for initializing the simulator or structuring the classes to expose the gym.Env interface. Gym-ignition provides the Task and Runtime abstractions that help you focusing on the development of the decision-making logic rather than engineering. It includes randomizers to simplify the implementation of domain randomization of models, physics, and tasks. Gym-ignition also provides powerful dynamics algorithms compatible with both fixed-base and floating-based robots by exploiting robotology/idyntree and exposing high-level functionalities.

Gym-ignition does not provide out-of-the-box environments ready to be used. Rather, its aim is simplifying and streamlining their development. Nonetheless, for illustrative purpose, it includes canonical examples in the gym_ignition_environments package.

Visit the website for more information about the project.

Installation

  1. First, follow the installation instructions of ScenarIO.
  2. pip install gym-ignition, preferably in a virtual environment.

Contributing

You can visit our community forum hosted in GitHub Discussions. Even without coding skills, replying user's questions is a great way of contributing. If you use gym-ignition in your application and want to show it off, visit the Show and tell section! You can advertise there your environments created with gym-ignition.

Pull requests are welcome.

For major changes, please open a discussion first to propose what you would like to change.

Citation

@INPROCEEDINGS{ferigo2020gymignition,
    title={Gym-Ignition: Reproducible Robotic Simulations for Reinforcement Learning},
    author={D. {Ferigo} and S. {Traversaro} and G. {Metta} and D. {Pucci}},
    booktitle={2020 IEEE/SICE International Symposium on System Integration (SII)},
    year={2020},
    pages={885-890},
    doi={10.1109/SII46433.2020.9025951}
} 

License

LGPL v2.1 or any later version.


Disclaimer: Gym-ignition is an independent project and is not related by any means to OpenAI and Open Robotics.

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

gym_ignition-1.3.1.tar.gz (252.1 kB view details)

Uploaded Source

Built Distribution

gym_ignition-1.3.1-py3-none-any.whl (62.3 kB view details)

Uploaded Python 3

File details

Details for the file gym_ignition-1.3.1.tar.gz.

File metadata

  • Download URL: gym_ignition-1.3.1.tar.gz
  • Upload date:
  • Size: 252.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for gym_ignition-1.3.1.tar.gz
Algorithm Hash digest
SHA256 691a76dedd59b4c3f2fe0deaf0a01f5af3ea62d101a86d0c939afa874863173f
MD5 a538933af1286b18d96c310dca7bdfb6
BLAKE2b-256 e4ffff52744644bf1a5901383fa4076a8945ce312fc43da82949a6bc7b9e7c40

See more details on using hashes here.

File details

Details for the file gym_ignition-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: gym_ignition-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 62.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for gym_ignition-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a3f5e02a0305248e22d133afb311954dac22a7d3f0e51ae34b9718ed7525e77
MD5 5dc761544ad9e730e6823535b7df95c2
BLAKE2b-256 1ea150c896589e70d979da5a516d280363ab06fc71d6686fe083cc66670301cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page