Seasonal

class getml.preprocessors.Seasonal(disable_year: bool = False, disable_month: bool = False, disable_weekday: bool = False, disable_hour: bool = False, disable_minute: bool = False)

Bases: _Preprocessor

The Seasonal preprocessor extracts seasonal data from time stamps.

The preprocessor automatically iterates through all time stamps in any data frame and extracts seasonal parameters.

These include:

• year

• month

• weekday

• hour

• minute

The algorithm also evaluates the potential usefulness of any extracted seasonal parameter. Parameters that are unlikely to be useful are not included.

Args:

disable_year (bool, optional):

Prevents the Seasonal preprocessor from extracting the year from time stamps.

disable_month (bool, optional):

Prevents the Seasonal preprocessor from extracting the month from time stamps.

disable_weekday (bool, optional):

Prevents the Seasonal preprocessor from extracting the weekday from time stamps.

disable_hour (bool, optional):

Prevents the Seasonal preprocessor from extracting the hour from time stamps.

disable_minute (bool, optional):

Prevents the Seasonal preprocessor from extracting the minute from time stamps.

Example:

seasonal = getml.preprocessors.Seasonal()

pipe = getml.Pipeline(
    population=population_placeholder,
    peripheral=[order_placeholder, trans_placeholder],
    preprocessors=[seasonal],
    feature_learners=[feature_learner_1, feature_learner_2],
    feature_selectors=feature_selector,
    predictors=predictor,
    share_selected_features=0.5
)

Attributes Summary

disable_hour
disable_minute
disable_month
disable_weekday
disable_year

Methods Summary

validate([params])

Checks both the types and the values of all instance variables and raises an exception if something is off.

Attributes Documentation

disable_hour: bool = False

disable_minute: bool = False

disable_month: bool = False

disable_weekday: bool = False

disable_year: bool = False

Methods Documentation

validate(params=None)

Checks both the types and the values of all instance variables and raises an exception if something is off.

Args:

params (dict, optional):

A dictionary containing the parameters to validate. If not is passed, the own parameters will be validated.