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

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}, 
}

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.2.tar.gz (40.3 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.2-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: algosrl-0.1.2.tar.gz
  • Upload date:
  • Size: 40.3 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.2.tar.gz
Algorithm Hash digest
SHA256 d718244187bd5edb059883cae110795411529b2e5592e0f1178a0ee1e1df3ebc
MD5 7429ea14735671283c20169ab9d012e8
BLAKE2b-256 2d1abfb16d027d3e25b99fac95d4a478fadc71e670c07da071f46c6ce3a7632a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: algosrl-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 52.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 315f2d901a13ccd798ec300678ed183d5ea44f67d1cdc9149a1dbfd7dcba0da1
MD5 a7ee124dfd85e86a72a3cf62fb84f997
BLAKE2b-256 1db2966e02acbc9621d80f10b49922f7d7c4133af43798438f2b21076c051170

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