Skip to main content

AlgOSRL: RL Module For AlgOS

This module utilises AlgOS as its core and provides an interface for implementing reinforcement learning algorithms.

AlgOS provides standardised:

  • experimental interface,
  • self organising algorithmic segments via AbstractParametered and AbstractComponent,
  • logging (can replace tensorboard logging with internal logger as .record interface is same),
  • central DB schema that supports PostgreSQL and MySQL (integrates with Optuna DB),
  • factory methods for dependency injection,
  • hyperparameter for automated hyperparameter optimisation, and
  • input parsing for automated script generation.

AlgOSRL extends this to work in the reinforcement learning space by:

  • providing an RLExperiment and RLComponent interface to extend,
  • a numpy replay buffer that offers indexed access,
  • wrappers for goal based RL that work with the maze environments from robotics_gymnasium,
  • wrapper for stable baselines 3 that allow the use of their off-policy agents, and
  • an evaluator for goals based on their coverage.

A wrapper for Tianshou also provided but has limited testing due to its incompatibility with Dict based inputs with its replay buffer and the integration of its replay buffer.

Installation

Install via pip:

pip install algosrl

Install from the cloned directory:

pip install -e .

Documentation

TBA

Examples

The examples folder contains an example runner script (runs a single experiment) and an example optimisation script (runs a study to find optimal hyperparameters). The optimisation script will run locally by default.

Roadmap

  • Provide Colab or Hugging face examples.
  • Generate documentation.
  • Include probabalistic curriculum learning code.

Citing the Project

To cite this repository in publications:

@misc{algos,
      title={AlgOS: Algorithm Operating System}, 
      author={Llewyn Salt and Marcus Gallagher},
      year={2025},
      eprint={2504.04909},
      archivePrefix={arXiv},
      primaryClass={cs.SE},
      url={https://arxiv.org/abs/2504.04909}, 
}

Metadata

Release files for algosrl 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for algosrl 0.1.2
File Size Uploaded Provenance Actions
algosrl-0.1.2.tar.gz 40.3 kB Without provenance Details for algosrl-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for algosrl 0.1.2
File Interpreter ABI Platform Actions
algosrl-0.1.2-py3-none-any.whl Python 3 none any Details for algosrl-0.1.2-py3-none-any.whl

Total release size: 92.3 kB

Release files / algosrl-0.1.2.tar.gz

Download URL algosrl-0.1.2.tar.gz
Size 40.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d718244187bd5edb059883cae110795411529b2e5592e0f1178a0ee1e1df3ebc
BLAKE2b-256 checksum
How to use checksums
2d1abfb16d027d3e25b99fac95d4a478fadc71e670c07da071f46c6ce3a7632a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.12

Release files / algosrl-0.1.2-py3-none-any.whl

Download URL algosrl-0.1.2-py3-none-any.whl
Size 52.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
315f2d901a13ccd798ec300678ed183d5ea44f67d1cdc9149a1dbfd7dcba0da1
BLAKE2b-256 checksum
How to use checksums
1db2966e02acbc9621d80f10b49922f7d7c4133af43798438f2b21076c051170
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.12

Security for algosrl 0.1.2

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page