import pytimetk as tk
tk.time_scale_template()| median_unit | seasonal_period | trend_period | |
|---|---|---|---|
| 0 | S | 1H | 12H |
| 1 | T | 1D | 14D |
| 2 | H | 1D | 1M |
| 3 | D | 1W | 3M |
| 4 | W | 1Q | 1Y |
| 5 | M | 1Y | 5Y |
| 6 | Q | 1Y | 10Y |
| 7 | Y | 5Y | 30Y |
time_scale_template
time_scale_template(wide_format=False, engine='pandas')
The function time_scale_template returns a table with time scale information in either wide or long format.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
wide_format |
bool | The wide_format parameter determines the format of the output table. If wide_format is set to True, the table will be transposed. | False |
engine |
str | The engine parameter is used to specify the engine to use for generating a date summary. It can be either โpandasโ or โpolarsโ. - The default value is โpandasโ. - When โpolarsโ, the function will internally use the polars library for generating the time scale information. |
'pandas' |