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.2.3.dev131.tar.gz (250.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gym_ignition-1.2.3.dev131-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

Details for the file gym_ignition-1.2.3.dev131.tar.gz.

File metadata

  • Download URL: gym_ignition-1.2.3.dev131.tar.gz
  • Upload date:
  • Size: 250.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.2 CPython/3.9.7

File hashes

Hashes for gym_ignition-1.2.3.dev131.tar.gz
Algorithm Hash digest
SHA256 8186b8a02d50637497857a23d9d65df49e52ce217e641f6a2776ff0595429de6
MD5 483d1a7b2464e86b068a01bb3cac4bc5
BLAKE2b-256 e33b556b009208569ba09c4c6c64e7bcdae78a3d0ebfc2838f6e1a7a87dafd89

See more details on using hashes here.

File details

Details for the file gym_ignition-1.2.3.dev131-py3-none-any.whl.

File metadata

  • Download URL: gym_ignition-1.2.3.dev131-py3-none-any.whl
  • Upload date:
  • Size: 62.1 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.2 CPython/3.9.7

File hashes

Hashes for gym_ignition-1.2.3.dev131-py3-none-any.whl
Algorithm Hash digest
SHA256 f8efc2e093ddb6133c6bcd082ebbc4171ce5732fba4febba1e9fd6cea26aa220
MD5 b968e7d8df02f26d0bdad4319058fb4a
BLAKE2b-256 51cd344d31e017ceda21e4782594b87ea2b1bca3545928ad4c56c30039057eda

See more details on using hashes here.

Supported by

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