RLRom
This module integrates Robust Online Monitoring methods with Reinforcement Learning stuff. The motivation is first to test RL agents using interpretable monitors, then use these monitors to train models to perform complex tasks, and/or converge toward behaviors that reliably satisfy certain requirements.
Install
Make sure build tools are installed, e.g., with apt:
$ sudo apt install build-essential
Then install with pip:
pip install rlrom
Getting Started
Command Line Interface
RLRom reads configuration files in the YAML format as inputs. Examples are provided in the examples folder. A command line interface is provided through command rlr which can be called with various arguments. For instance, the rlr test command reads a configuration file and runs tests:
$ rlr test examples/cartpole/cfg0_hug.cfg
will run a few episode of the cartpole classic environment, fetching a model on huggingface and monitor a formula on these episodes.
For training with or without STL specifications, use the rlr train command, e.g.:
$ rlr train examples/cartpole/cfg0tr_ppo_specs.cfg
More details are provided in the notebooks (see below.)
Notebook Examples
More programmatic features are demonstrated in notebooks, in particular
-
The Cart Pole notebook presents a case study around the classic Cart Pole Gymnasium environment.
-
The Highway-env notebook presents a slightly more involved autonomous driving example based on the highway-env environment.
Metadata
Release files for rlrom 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rlrom-0.2.0.tar.gz | 24.3 kB | Without provenance | Details for rlrom-0.2.0.tar.gz |
Release files / rlrom-0.2.0.tar.gz
| Download URL | rlrom-0.2.0.tar.gz |
|---|---|
| Size | 24.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40b2e134adba4aefe84d265d8cd98c5592db154b0c5d5962161120fc24d450af
|
|
BLAKE2b-256 checksum How to use checksums |
7b818da05681b802a9ed194d55785fbf12f7391cb9b70d0444e44b98b3798a68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
Security for rlrom 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.