1. Synthetic Panel Data
source
generate_series
*Generate Synthetic Panel Series. Generates
n_series of frequency freq of different lengths in the
interval [min_length, max_length]. If n_static_features > 0,
then each series gets static features with random values. If
equal_ends == True then all series end at the same date.*
| Type | Default | Details | |
|---|---|---|---|
| n_series | int | Number of series for synthetic panel. | |
| freq | str | D | Frequency of the data, ‘D’ or ‘M’. |
| min_length | int | 50 | Minimum length of synthetic panel’s series. |
| max_length | int | 500 | Maximum length of synthetic panel’s series. |
| n_static_features | int | 0 | Number of static exogenous variables for synthetic panel’s series. |
| equal_ends | bool | False | Series should end in the same date stamp ds. |
| engine | str | pandas | Output Dataframe type (‘pandas’ or ‘polars’). |
| seed | int | 0 | Random seed used for generating the data. |
| Returns | Union | Synthetic panel with columns [unique_id, ds, y] and exogenous. |

