openstef package#

Subpackages#

Submodules#

openstef.enums module#

class openstef.enums.ForecastType(value)#

Bases: Enum

An enumeration.

BASECASE = 'basecase'#
DEMAND = 'demand'#
SOLAR = 'solar'#
WIND = 'wind'#
class openstef.enums.MLModelType(value)#

Bases: Enum

An enumeration.

ARIMA = 'arima'#
LGB = 'lgb'#
LINEAR = 'linear'#
ProLoaf = 'proloaf'#
XGB = 'xgb'#
XGB_QUANTILE = 'xgb_quantile'#
class openstef.enums.PipelineType(value)#

Bases: Enum

An enumeration.

FORECAST = 'forecast'#
HYPER_PARMATERS = 'hyper_parameters'#
TRAIN = 'train'#
class openstef.enums.TracyJobResult(value)#

Bases: Enum

An enumeration.

FAILED = 'failed'#
SUCCESS = 'success'#
UNKNOWN = 'unknown'#

openstef.exceptions module#

Openstef custom exceptions.

exception openstef.exceptions.ComponentForecastTooShortHorizonError#

Bases: Exception

Component forecasts should be available for at least 30 hours in advance.

exception openstef.exceptions.InputDataInsufficientError#

Bases: InputDataInvalidError

Insufficient input data.

exception openstef.exceptions.InputDataInvalidError#

Bases: Exception

Invalid input data.

exception openstef.exceptions.InputDataOngoingZeroFlatlinerError#

Bases: InputDataInvalidError

All recent load measurements are zero.

exception openstef.exceptions.InputDataWrongColumnOrderError#

Bases: InputDataInvalidError

Wrong column order input data.

exception openstef.exceptions.ModelWithoutStDev#

Bases: Exception

A machine learning model should have a valid standard deviation.

exception openstef.exceptions.NoPredictedLoadError(pid, message='No predicted load found')#

Bases: Exception

No predicted load for given datatime range.

exception openstef.exceptions.NoRealisedLoadError(pid, message='No realised load found')#

Bases: Exception

No realised load for given datetime range.

exception openstef.exceptions.OldModelHigherScoreError#

Bases: Exception

Old model has a higher score then new model.

exception openstef.exceptions.PredictionJobException(metrics=None)#

Bases: Exception

One or more prediction jobs raised an exception.

exception openstef.exceptions.SkipSaveTrainingForecasts#

Bases: Exception

If old model is better or too young, you don’t need to save the traing forcast.

Module contents#