doenut.data.modifiers.data_set_modifier

Module Contents

Classes

DataSetModifier

Parent class for all types of modifier.

class doenut.data.modifiers.data_set_modifier.DataSetModifier(inputs: pandas.DataFrame, responses: pandas.DataFrame, **kwargs)

Bases: abc.ABC

Parent class for all types of modifier. They take a dataset in, perform some form of operation on it and then pass it along

Parameters:

inputs (pd.DataFrame) – The dataset’s inputs

responsespd.DataFrame

The dataset’s responses

**kwargsdict, optional

Any extra arguments needed by individual modifiers.

Note

This is an abstract class and should not be used directly.

abstract apply_to_inputs(data: pandas.DataFrame) → pandas.DataFrame

Applies the modifier to the inputs of the dataset.

Parameters:

data (pd.DataFrame) – The input data

Returns:

The modified input data

Return type:

pd.DataFrame

abstract apply_to_responses(data: pandas.DataFrame) → pandas.DataFrame

Applies the modifier to the responses of the dataset.

Parameters:

data (pd.DataFrame) – The response data

Returns:

The modified response data

Return type:

pd.DataFrame