acoupipe.base

Base classes for AcouPipe.

This module provides abstract base classes that form the foundation of the AcouPipe architecture. These classes are not intended to be used directly, but to be subclassed by classes that implement the actual functionality.

digraph inheritance64f30516ac { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABCHasStrictTraits" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A HasTraits subclass which behaves like HasStrictTraits but"]; "ABCHasTraits" -> "ABCHasStrictTraits" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABCHasTraits" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A HasTraits subclass which enables the features of Abstract"]; "HasTraits" -> "ABCHasTraits" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseSampler" [URL="#acoupipe.base.BaseSampler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class that represents a random process."]; "ABCHasStrictTraits" -> "BaseSampler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CHasTraits" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for HasTraits."]; "DataGenerator" [URL="#acoupipe.base.DataGenerator",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract base class that serves as a data generator."]; "ABCHasStrictTraits" -> "DataGenerator" [arrowsize=0.5,style="setlinewidth(0.5)"]; "HasTraits" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Enables any Python class derived from it to have trait attributes."]; "CHasTraits" -> "HasTraits" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Module Contents

class acoupipe.base.DataGenerator

Bases: traits.api.ABCHasStrictTraits

Abstract base class that serves as a data generator.

This class should not be used directly. It provides a common interface for all classes that generate data via the result() method in a block-wise or sample-wise manner.

abstractmethod get_data()

Python generator that iteratively yields data set samples as a dictionary.

This method needs to be implemented by derived classes.

Returns:

dict

Dictionary containing a sample of the data set {feature_name[key] : feature[values]}.

class acoupipe.base.BaseSampler

Bases: traits.api.ABCHasStrictTraits

Base class that represents a random process.

This class has no functionality and should not be used in practice. It provides a common interface for all classes that manipulate attributes of an instance or a list of instances according to a specified random distribution.

rvs(size=1)

Random variable sampling (for internal use).

Parameters:

sizeint, optional

The size of the output array. Defaults to 1.

Returns:

array-like

Random values drawn from the random distribution.

abstractmethod sample()

Utilizes rvs() function to draw random values from the random distribution.

This method needs to be implemented by derived classes to perform the actual sampling and assign values to the target instances.