https://github.com/rickstaa/stable-gym

This package contains several gymnasium environments with positive definite cost functions, designed for compatibility with stable RL agents.
https://github.com/rickstaa/stable-gym

artificial-intelligence gym-environments gymnasium openai-gym reinforcement-learning robustness simulation stability

Last synced: 4 months ago
JSON representation

This package contains several gymnasium environments with positive definite cost functions, designed for compatibility with stable RL agents.

• Host: GitHub
• URL: https://github.com/rickstaa/stable-gym
• Owner: rickstaa
• License: mit
• Created: 2020-08-14T09:56:22.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T01:15:24.000Z (10 months ago)
• Last Synced: 2024-05-01T16:39:21.720Z (9 months ago)
• Topics: artificial-intelligence, gym-environments, gymnasium, openai-gym, reinforcement-learning, robustness, simulation, stability
• Language: Python
• Homepage: https://rickstaa.dev/stable-gym
• Size: 25.4 MB
• Stars: 10
• Watchers: 4
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# Stable Gym

[![Stable Gym](https://github.com/rickstaa/stable-gym/actions/workflows/stable_gym.yml/badge.svg)](https://github.com/rickstaa/stable-gym/actions/workflows/stable_gym.yml)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rickstaa/stable-gym)](https://github.com/rickstaa/stable-gym/releases)

[![Python 3](https://img.shields.io/badge/Python->=3.8-brightgreen)](https://www.python.org/)

[![codecov](https://codecov.io/gh/rickstaa/stable-gym/branch/main/graph/badge.svg?token=RFM3OELQ3L)](https://codecov.io/gh/rickstaa/stable-gym)

[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)

[![DOI](https://zenodo.org/badge/287501190.svg)](https://zenodo.org/badge/latestdoi/287501190)

A Python package that contains several [gymnasium environments](https://gymnasium.farama.org/) with positive definite cost functions, designed for compatibility with stable RL agents. It was initially created for the stable RL algorithms in the [Stable Learning Control](https://github.com/rickstaa/stable-learning-control) package but can be used with any RL agent requiring a **positive definite cost function**. For more information about stable RL agents see the [Stable Learning Control documentation](https://rickstaa.dev/stable-learning-control).

## Installation and Usage

Please see the accompanying [documentation](https://rickstaa.dev/stable-gym) for information on installing and using this package.

## Contributing

We use [husky](https://github.com/typicode/husky) pre-commit hooks and github actions to enforce high code quality. Before contributing to this repository, please check the [contribution guidelines](CONTRIBUTING.md).

> \[!NOTE]\

> We used [husky](https://github.com/typicode/husky) instead of [pre-commit](https://pre-commit.com/), which is more commonly used with Python projects. This was done because only some tools we wanted to use were possible to integrate the Please feel free to open a [PR](https://github.com/rickstaa/stable-gym/pulls) if you want to switch to pre-commit if this is no longer the case.