Skip to main content

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

Project description

gym-ignition

WhatWhyHowDemoSetupCitation


General C++ Standard Size Size
CI/CD Docker Images CI PyPI CD Codacy Badge
gym-ignition


What

Gym-Ignition is a framework to create reproducible robotics environments for reinforcement learning research.

The project is composed of the following components:

Component Description
ScenarI/O Scene Interfaces for Robot Input / Output is a set of C++ interfaces to abstract the interfacing with simulated and real robots.
Gazebo ScenarI/O Ignition Gazebo bindings that expose the ScenarI/O interfaces.
gym-ignition Python package that provides the tooling to create OpenAI Gym environments for robot learning.
gym-ignition-environments Demo environments created with gym-ignition and gym-ignition-models.
Gympp An experimental C++ port of the OpenAI Gym interfaces, used to create pure C++ environments.

Disclaimer: we do not provide support for experimental components.

Why

Refer to the Citation for the extended rationale behind this project.

TL;DR

We designed Gym-Ignition driven by the following reasons:

  • Advances in RL research are pushed by the development of more complex environments, and vice versa.
  • There's no standard framework in the robotics community for creating simulated robotic environments.
  • Environments that can be transferred from simulation to reality with minimal changes are yet to be seen.
  • Alternative solutions are not developed by roboticists for roboticist, and therefore they do not use familiar tools.
  • Existing robotics environments are typically difficult to adapt to run on different physics engines and different robots.
  • Only few solutions offer realistic rendering capabilities.

How

This project interfaces with the new generation of the Gazebo simulator, called Ignition Gazebo. It is part of the new Ignition Robotics suite developed by Open Robotics.

Ignition Robotics is currently under heavy development. Though, it already offers enough functionalities that fit this project's aims:

  • Simulator-as-a-library
  • New modular architecture
  • C++ utilities developed with a robotic mindset
  • New abstractions of physics engines and rendering engines that exploit runtime plugins
  • Full support of DART and coming support of bullet3
  • Support of distributed simulations
  • Well maintained and packaged
  • Ignition Fuel database to download models and worlds

Our Gazebo ScenarI/O component provides Python bindings of the simulator that are comparable to other popular solutions like pybullet and mujoco-py.

Features

At the time of writing, Gym-Ignition offers the following features:

  • Environments compatible with OpenAI Gym
  • Worlds and models are SDF descriptions
  • Reproducibility guarantees
  • Accelerated and multiprocess execution
  • Environments are a combination of three elements:
    • Task: the logic of the decision-making problem. It defines how to process the given action, how to calculate the reward, how to structure the observation, and how to reset the environment. Task objects are robot-independent and runtime-independent.
    • World: unified interface to access world resources.
    • Runtime: implements the actual step of the environment. Simulated runtimes step the simulator, real-time runtimes deal with real-time execution constraints. A Task object can be executed by any runtime without any change.
  • Experimental support to create C++ environments

Demo

We provide a docker image that shows few rollouts executed by a random policy on a cartpole model:

docker pull diegoferigo/gym-ignition:latest
pip3 install rocker

# Intel GPU
rocker --devices /dev/dri --x11 diegoferigo/gym-ignition /github/examples/python/launch_cartpole.py

# Nvidia GPU
rocker --x11 --nvidia diegoferigo/gym-ignition /github/examples/python/launch_cartpole.py

Setup

Visit the Installation section of our website for updated installation instructions. Make sure to select the correct branch since the installation could differ depending on the branch you're interested.

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}
} 

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.0b3.dev432.tar.gz (212.5 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.0b3.dev432-cp38-cp38-manylinux1_x86_64.whl (4.0 MB view details)

Uploaded CPython 3.8

File details

Details for the file gym-ignition-1.0b3.dev432.tar.gz.

File metadata

  • Download URL: gym-ignition-1.0b3.dev432.tar.gz
  • Upload date:
  • Size: 212.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.6

File hashes

Hashes for gym-ignition-1.0b3.dev432.tar.gz
Algorithm Hash digest
SHA256 2898f92b0d807b59ac087b17092a9af8bda1a2577f5b09d8b67e1678dc45360e
MD5 e08230b69a01de2025fce24da92dd0f1
BLAKE2b-256 889bc8b808085c4717b77906576c26395e3b0f5e8f793d1a01a8fac80186b444

See more details on using hashes here.

File details

Details for the file gym_ignition-1.0b3.dev432-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: gym_ignition-1.0b3.dev432-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 4.0 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.6

File hashes

Hashes for gym_ignition-1.0b3.dev432-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 359618c8e88f83c15cf2475d6cc882140b4d5e58bfb61e48e31af5c31a752a97
MD5 ffaae59a5cbabb64af070cd9c8651a61
BLAKE2b-256 5f8e333f1d77a78328947156f4aeb143607b3910fb5156499360c49994745d53

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