Yet Another Reinforcement Learning Library
Project description
yarllib
Yet Another Reinforcement Learning Library.
Status: development.
Why?
I had the need for a RL library/framework that:
- was clearly and simply implemented, with good enough performances;
- highly focused on modularity, customizability and extendability;
- wasn't merely Deep Reinforcement Learning oriented.
I couldn't find an existing library that satisfied my needs; hence I decided to implement yet another RL library.
For me it is also an opportunity to have a better understanding of the RL algorithms and to appreciate the nuances that you can't find on a book.
If you find this repo useful for your research or your project, I'd be very glad :-) don't hesitate to reach me out!
What
The package is both:
- a library, because it provides off-the-shelf functionalities to set up an RL experiment;
- a framework, because you can compose your custom model by implementing the interfaces, override the default behaviours, or use the existing components as-is.
You can find more details in the documentation.
Tests
To run tests: tox
To run only the code tests: tox -e py3.7
To run only the linters:
tox -e flake8
tox -e mypy
tox -e black-check
tox -e isort-check
Please look at the tox.ini
file for the full list of supported commands.
Docs
To build the docs: mkdocs build
To view documentation in a browser: mkdocs serve
and then go to http://localhost:8000
License
yarllib is released under the GNU Lesser General Public License v3.0 or later (LGPLv3+).
Copyright 2020 Marco Favorito
Authors
Cite
If you use this library for your research, please consider citing this repository:
@misc{favorito2020,
Author = {Marco Favorito},
Title = {yarllib: Yet Another Reinforcement Learning Library},
Year = {2020},
}
An e-print will come soon :-)
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
Built Distribution
File details
Details for the file yarllib-0.2.0.tar.gz
.
File metadata
- Download URL: yarllib-0.2.0.tar.gz
- Upload date:
- Size: 18.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e747fd729daf84a67df84182e995f6e485a2064af2b04a4a7cb104f77bc29b05 |
|
MD5 | 23ae468102dbf4bfa712c04b9ad90732 |
|
BLAKE2b-256 | d142c07ff15cfbd19861c1aa3a69889a0e0c903bebaf508976df585e3d7ae0c5 |
File details
Details for the file yarllib-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: yarllib-0.2.0-py3-none-any.whl
- Upload date:
- Size: 26.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b62d6d57339dd5be425c35d612e061910808019c301507a1de816b2119cbffa8 |
|
MD5 | a2ff05ee54258822321dc1718775637e |
|
BLAKE2b-256 | eb8b5b1e48aa603298f85928c77ca379b6bed45e88e08c174bee9b79d92df873 |