API definitions#

This module contains generic API definitions for pyAerial pipelines.

class aerial.phy5g.api.SlotConfig#: An empty base class for all slot configuration data classes.

class aerial.phy5g.api.PipelineConfig#: An empty base class for all pipeline configuration data classes.

class aerial.phy5g.api.PipelineFactory#

A generic pipeline factory defining the interface that the factories need to implement.

abstract create(config, cuda_stream, **kwargs)#

Create the pipeline.

Parameters:

config (PipelineConfig) – Pipeline configuration. Note that for the implementation of this method, a PipelineConfig may also be subclassed to implement an arbitrary pipeline configuration.
cuda_stream (int) – CUDA stream used to run the pipeline.
kwargs (Any)

Returns:

A pipeline object, the class of which is derived from Pipeline.

Return type:

Pipeline