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.1.tar.gz (40.4 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.1-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: algosrl-0.1.1.tar.gz
  • Upload date:
  • Size: 40.4 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.1.tar.gz
Algorithm Hash digest
SHA256 36f8e57863aefb9fb9bebb4831add3a1392a222c87c4843f0e0ad7f2359bc34b
MD5 0fb001501d5839f8431228c12d14c6e5
BLAKE2b-256 f305a2924c0d57e6d6783ff927d82d95f6521ada3847c37216c0c053ee260b3d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: algosrl-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 52.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6697f0ce1bf91b6993d0f9f83c541088cddf939b9973e8976b0934484bb07c72
MD5 fc6d6a8623770079b418e8fe37cce451
BLAKE2b-256 c9c43c10ce32f8305a6080be94c1c35dbb39d1d82a209718c4975df31c4f75fe

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