skrl


Nameskrl JSON
Version 1.1.0 PyPI version JSON
download
home_page
SummaryModular and flexible library for reinforcement learning on PyTorch and JAX
upload_time2024-02-13 04:12:39
maintainerToni-SM
docs_urlNone
authorToni-SM
requires_python>=3.6
licenseMIT License
keywords reinforcement-learning machine-learning reinforcement machine learning rl
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pypi](https://img.shields.io/pypi/v/skrl)](https://pypi.org/project/skrl)
[<img src="https://img.shields.io/badge/%F0%9F%A4%97%20models-hugging%20face-F8D521">](https://huggingface.co/skrl)
![discussions](https://img.shields.io/github/discussions/Toni-SM/skrl)
<br>
[![license](https://img.shields.io/github/license/Toni-SM/skrl)](https://github.com/Toni-SM/skrl)
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
[![docs](https://readthedocs.org/projects/skrl/badge/?version=latest)](https://skrl.readthedocs.io/en/latest/?badge=latest)
[![pytest](https://github.com/Toni-SM/skrl/actions/workflows/python-test.yml/badge.svg)](https://github.com/Toni-SM/skrl/actions/workflows/python-test.yml)
[![pre-commit](https://github.com/Toni-SM/skrl/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/Toni-SM/skrl/actions/workflows/pre-commit.yml)

<br>
<p align="center">
  <a href="https://skrl.readthedocs.io">
  <img width="300rem" src="https://raw.githubusercontent.com/Toni-SM/skrl/main/docs/source/_static/data/logo-light-mode.png">
  </a>
</p>
<h2 align="center" style="border-bottom: 0 !important;">SKRL - Reinforcement Learning library</h2>
<br>

**skrl** is an open-source modular library for Reinforcement Learning written in Python (on top of [PyTorch](https://pytorch.org/) and [JAX](https://jax.readthedocs.io)) and designed with a focus on modularity, readability, simplicity, and transparency of algorithm implementation. In addition to supporting the OpenAI [Gym](https://www.gymlibrary.dev) / Farama [Gymnasium](https://gymnasium.farama.org) and [DeepMind](https://github.com/deepmind/dm_env) and other environment interfaces, it allows loading and configuring [NVIDIA Isaac Gym](https://developer.nvidia.com/isaac-gym/), [NVIDIA Isaac Orbit](https://isaac-orbit.github.io/orbit/index.html) and [NVIDIA Omniverse Isaac Gym](https://docs.omniverse.nvidia.com/isaacsim/latest/tutorial_gym_isaac_gym.html) environments, enabling agents' simultaneous training by scopes (subsets of environments among all available environments), which may or may not share resources, in the same run.

<br>

### Please, visit the documentation for usage details and examples

<strong>https://skrl.readthedocs.io</strong>

<br>

> **Note:** This project is under **active continuous development**. Please make sure you always have the latest version. Visit the [develop](https://github.com/Toni-SM/skrl/tree/develop) branch or its [documentation](https://skrl.readthedocs.io/en/develop) to access the latest updates to be released.

<br>

### Citing this library

To cite this library in publications, please use the following reference:

```bibtex
@article{serrano2023skrl,
  author  = {Antonio Serrano-Muñoz and Dimitrios Chrysostomou and Simon Bøgh and Nestor Arana-Arexolaleiba},
  title   = {skrl: Modular and Flexible Library for Reinforcement Learning},
  journal = {Journal of Machine Learning Research},
  year    = {2023},
  volume  = {24},
  number  = {254},
  pages   = {1--9},
  url     = {http://jmlr.org/papers/v24/23-0112.html}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "skrl",
    "maintainer": "Toni-SM",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "reinforcement-learning,machine-learning,reinforcement,machine,learning,rl",
    "author": "Toni-SM",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/fe/f8/94e173843b8f837dd9f9b55ebb597a591c237781e2fad56c6654dbaa9709/skrl-1.1.0.tar.gz",
    "platform": null,
    "description": "[![pypi](https://img.shields.io/pypi/v/skrl)](https://pypi.org/project/skrl)\n[<img src=\"https://img.shields.io/badge/%F0%9F%A4%97%20models-hugging%20face-F8D521\">](https://huggingface.co/skrl)\n![discussions](https://img.shields.io/github/discussions/Toni-SM/skrl)\n<br>\n[![license](https://img.shields.io/github/license/Toni-SM/skrl)](https://github.com/Toni-SM/skrl)\n<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>\n[![docs](https://readthedocs.org/projects/skrl/badge/?version=latest)](https://skrl.readthedocs.io/en/latest/?badge=latest)\n[![pytest](https://github.com/Toni-SM/skrl/actions/workflows/python-test.yml/badge.svg)](https://github.com/Toni-SM/skrl/actions/workflows/python-test.yml)\n[![pre-commit](https://github.com/Toni-SM/skrl/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/Toni-SM/skrl/actions/workflows/pre-commit.yml)\n\n<br>\n<p align=\"center\">\n  <a href=\"https://skrl.readthedocs.io\">\n  <img width=\"300rem\" src=\"https://raw.githubusercontent.com/Toni-SM/skrl/main/docs/source/_static/data/logo-light-mode.png\">\n  </a>\n</p>\n<h2 align=\"center\" style=\"border-bottom: 0 !important;\">SKRL - Reinforcement Learning library</h2>\n<br>\n\n**skrl** is an open-source modular library for Reinforcement Learning written in Python (on top of [PyTorch](https://pytorch.org/) and [JAX](https://jax.readthedocs.io)) and designed with a focus on modularity, readability, simplicity, and transparency of algorithm implementation. In addition to supporting the OpenAI [Gym](https://www.gymlibrary.dev) / Farama [Gymnasium](https://gymnasium.farama.org) and [DeepMind](https://github.com/deepmind/dm_env) and other environment interfaces, it allows loading and configuring [NVIDIA Isaac Gym](https://developer.nvidia.com/isaac-gym/), [NVIDIA Isaac Orbit](https://isaac-orbit.github.io/orbit/index.html) and [NVIDIA Omniverse Isaac Gym](https://docs.omniverse.nvidia.com/isaacsim/latest/tutorial_gym_isaac_gym.html) environments, enabling agents' simultaneous training by scopes (subsets of environments among all available environments), which may or may not share resources, in the same run.\n\n<br>\n\n### Please, visit the documentation for usage details and examples\n\n<strong>https://skrl.readthedocs.io</strong>\n\n<br>\n\n> **Note:** This project is under **active continuous development**. Please make sure you always have the latest version. Visit the [develop](https://github.com/Toni-SM/skrl/tree/develop) branch or its [documentation](https://skrl.readthedocs.io/en/develop) to access the latest updates to be released.\n\n<br>\n\n### Citing this library\n\nTo cite this library in publications, please use the following reference:\n\n```bibtex\n@article{serrano2023skrl,\n  author  = {Antonio Serrano-Mu\u00f1oz and Dimitrios Chrysostomou and Simon B\u00f8gh and Nestor Arana-Arexolaleiba},\n  title   = {skrl: Modular and Flexible Library for Reinforcement Learning},\n  journal = {Journal of Machine Learning Research},\n  year    = {2023},\n  volume  = {24},\n  number  = {254},\n  pages   = {1--9},\n  url     = {http://jmlr.org/papers/v24/23-0112.html}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Modular and flexible library for reinforcement learning on PyTorch and JAX",
    "version": "1.1.0",
    "project_urls": {
        "Bug Reports": "https://github.com/Toni-SM/skrl/issues",
        "Discussions": "https://github.com/Toni-SM/skrl/discussions",
        "Documentation": "https://skrl.readthedocs.io",
        "Homepage": "https://github.com/Toni-SM/skrl",
        "Say Thanks!": "https://github.com/Toni-SM",
        "Source": "https://github.com/Toni-SM/skrl"
    },
    "split_keywords": [
        "reinforcement-learning",
        "machine-learning",
        "reinforcement",
        "machine",
        "learning",
        "rl"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5bc59e6b4e1acd4513bb77c2bba714077e0772550ff3b583dd23ec788f564593",
                "md5": "77978500ec93d1f280e65dbdc22ac67f",
                "sha256": "b9dfc079663c84c156d8b8e24c3a9d3571b9166651215af47ceeb7998fb3ab9d"
            },
            "downloads": -1,
            "filename": "skrl-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "77978500ec93d1f280e65dbdc22ac67f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 345619,
            "upload_time": "2024-02-13T04:12:38",
            "upload_time_iso_8601": "2024-02-13T04:12:38.096506Z",
            "url": "https://files.pythonhosted.org/packages/5b/c5/9e6b4e1acd4513bb77c2bba714077e0772550ff3b583dd23ec788f564593/skrl-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fef894e173843b8f837dd9f9b55ebb597a591c237781e2fad56c6654dbaa9709",
                "md5": "4b0e766d7fd66cd7aa197de4ea472e3a",
                "sha256": "39b30242f77c50040c86e413c50096cc3f448da8a462095d035852abf71e816d"
            },
            "downloads": -1,
            "filename": "skrl-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4b0e766d7fd66cd7aa197de4ea472e3a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 166987,
            "upload_time": "2024-02-13T04:12:39",
            "upload_time_iso_8601": "2024-02-13T04:12:39.546034Z",
            "url": "https://files.pythonhosted.org/packages/fe/f8/94e173843b8f837dd9f9b55ebb597a591c237781e2fad56c6654dbaa9709/skrl-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-13 04:12:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Toni-SM",
    "github_project": "skrl",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "skrl"
}
        
Elapsed time: 0.18791s