Skip to main content

Algorithm OS RL: An RL module for AlgOS

Project description

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

Currently the install method is to invoke the following 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}, 
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

algosrl-0.1.0.tar.gz (34.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

algosrl-0.1.0-py3-none-any.whl (42.5 kB view details)

Uploaded Python 3

File details

Details for the file algosrl-0.1.0.tar.gz.

File metadata

  • Download URL: algosrl-0.1.0.tar.gz
  • Upload date:
  • Size: 34.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for algosrl-0.1.0.tar.gz
Algorithm Hash digest
SHA256 96f3d047c5e1ccf5f1afc24d41b9f115c1c17d65f9c3bd3e7f7fbd350a59f880
MD5 1dada75fa4f923270302dcb7952f11f7
BLAKE2b-256 f6bda9f8e471b4da4afb45f2a67c950d188abba810b4f8151fe5bc89d117bffc

See more details on using hashes here.

File details

Details for the file algosrl-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: algosrl-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 42.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for algosrl-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d672ea9a7752d6df4ba1b5f5e8f075772da496af57e77025dd5a3863effd5cf
MD5 370d8f0e1fa6630d6c88636d33f0d1b1
BLAKE2b-256 5608f09db72ebb5081bca779d34fe50ac871385c2380fc18216062aabc201711

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page