make_example_dataframe_series¶

make_example_dataframe_series(n_timepoints: int = 12, n_channels: int = 1, index_type=None, random_state: int | None = None, axis: int = 1) → DataFrame[source]¶

Randomly generate pandas DataFrame X.

Generates data in ‘pd.DataFrame’ format.

Parameters:

n_timepointsint, default=12: The number of features/series length to generate.
n_channelsint, default=1: The number of series channels to generate.
index_typestr or None, default=None: pandas Index type to use. One of [“period”, “datetime”, “range”, “int”]. If None, uses default integer index.
random_stateint or None, default=None: Seed for random number generation.
axisint, default=1: The axis to for the series timepoints. If 1, returns the shape (n_channels, n_timepoints). If 0, returns the shape (n_timepoints, n_channels).

Returns:

Xpd.DataFrame: Randomly generated 2D data.

Examples

>>> from aeon.testing.data_generation import make_example_dataframe_series
>>> data = make_example_dataframe_series(
...     n_timepoints=6,
...     n_channels=2,
...     random_state=0,
...     axis=0,
... )
>>> print(data)
          0         1
0  0.548814  0.715189
1  0.602763  0.544883
2  0.423655  0.645894
3  0.437587  0.891773
4  0.963663  0.383442
5  0.791725  0.528895