preprocessing.exog_providers.build_providers

preprocessing.exog_providers.build_providers(
    flags,
    *,
    data_home=None,
    max_gap=0,
    max_tail_gap=0,
    provider_window=None,
)

Construct the providers whose flags are truthy, in registry order.

Parameters

Name	Type	Description	Default
flags	Mapping[str, bool]	Mapping from registry flag name to a boolean. Unknown keys are ignored; missing keys are treated as False.	required
data_home	DataHome	Root data directory forwarded to each provider.	None
max_gap	int	Maximum contiguous missing-value run forwarded to each provider. See _align_to_index. Defaults to 0.	0
max_tail_gap	int	Extended trailing-edge healing budget forwarded to each provider. See _align_to_index. Defaults to 0.	0
provider_window	Optional[pd.DatetimeIndex]	Validation index forwarded to each provider as provider_window. See _align_to_index. Defaults to None.	None

Returns

Name	Type	Description
	List[ExogFeatureProvider]	List[ExogFeatureProvider]: Providers for the enabled flags, in the fixed
	List[ExogFeatureProvider]	order of EXOG_PROVIDER_REGISTRY (deterministic column ordering).

Examples

from spotforecast2_safe.preprocessing.exog_providers import build_providers

providers = build_providers({"include_entsoe_forecast_load": True})
print([p.name for p in providers])

['entsoe_forecasted_load']