Saltar al contenido principal

BuildForecasterUnit

Unit
DashAI.back.units.BuildForecasterUnit

Instantiate an unfitted forecaster, with the season its grid implies.

A forecaster with a season_length that the run leaves out gets the season the series' frequency implies: 12 for a monthly series, 7 for a daily one, 24 for an hourly one (D3). The model receives only the number; the frequency is this unit's to read. A season the run gives, even 1, is kept.

The sibling for the x/y tasks is BuildModelUnit, which sizes a model by its label count and attaches the metrics it logs while training. A forecaster has no labels, and its metrics are scored on the forecasts of a backtest, by ScoreForecastsUnit.

Parameters​

model : object
Forecaster to instantiate, along with its own configuration.

Methods​

execute(self, ctx: DashAI.back.units.context.ExecutionContext) -> None

Defined on BuildForecasterUnit

Do the unit's work, reading from and writing to the context.

Parameters

ctx : ExecutionContext
The shared execution context.

get_credential(self, name: str)

Defined on ConfigObject

Resolve a registered credential component by name.

Parameters

name : str
Credential component class name (e.g. "HuggingFaceCredential").

Returns

BaseCredential
An instance of the requested credential component.

get_schema(cls) -> dict

Defined on ConfigObject

Generates the component related Json Schema.

Returns

dict
Dictionary representing the Json Schema of the component.

validate(self, ctx: DashAI.back.units.context.ExecutionContext) -> None

Defined on BaseUnit

Check preconditions without executing the unit.

Parameters

ctx : ExecutionContext
The shared execution context.

validate_and_transform(self, raw_data: dict) -> dict

Defined on ConfigObject

It takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.

Parameters

raw_data : dict
A dictionary with the data provided by the user to initialize the model.

Returns

dict
A validated dictionary with the necessary objects.