API Reference

The following section provides an exhaustive documentation of CoRelAy’s constituent modules, classes, methods, and functions. It offers in-depth descriptions of their respective functionalities, parameter details, and usage examples.

corelay.base

A module that contains core CoRelAy classes, such as Param.

corelay.io

A sub-package containing IO-related modules for storing intermediate results of operations performed by instances of Processor.

corelay.pipeline

A sub-package that contains pipelines, which perform a set of tasks represented by a special Slot type called Task.

corelay.plugboard

A module that contains the Plugboard class.

corelay.processor

A sub-package that contains the abstract base class for all processors, Processor.

corelay.tracker

A module that contains the Tracker, which is used to track Slot definitions in classes that inherit from Plugboard.

corelay.utils

A module containing utility classes and functions for CoRelAy.