SeasonalityTest

class hana_ai.tools.hana_ml_tools.ts_check_tools.SeasonalityTest(connection_context: ConnectionContext, return_direct: bool = False)

This tool calls seasonality test for the given time series data.

Parameters:

connection_contextConnectionContext: Connection context to the HANA database.

Returns:

str

The seasonality of the time series data.

Note

args_schema is used to define the schema of the inputs as follows:

Field	Description
table_name	the name of the table. If not provided, ask the user. Do not guess.
key	the key of the dataset. If not provided, ask the user. Do not guess.
endog	the endog of the dataset. If not provided, ask the user. Do not guess
schema_name	the schema_name of the table, it is optional
alpha	the criterion for the autocorrelation coefficient, it is optional
decompose_type	the type of decomposition chosen from {'additive', 'multiplicative', 'auto'}, it is optional
extrapolation	whether to extrapolate the endpoints or not, it is optional
smooth_width	the width of the smoothing window, it is optional
auxiliary_normalitytest	specifies whether to use normality test to identify model types, it is optional
periods	the length of the periods, it is optional
decompose_method	the method of decomposition chosen from {'stl', 'traditional'}, it is optional
stl_robust	whether to use robust decomposition or not only valid for 'stl' decompose method, it is optional
stl_seasonal_average	whether to use seasonal average or not only valid for 'stl' decompose method, it is optional
smooth_method_non_seasonal	the method of smoothing for non-seasonal component chosen from {'moving_average', 'super_smoother'}, it is optional

connection_context: ConnectionContext: Connection context to the HANA database.