search

tslearn-team / tslearn

The machine learning toolkit for time series analysis in Python
https://tslearn.readthedocs.io
BSD 2-Clause "Simplified" License
2.89k stars 336 forks source link

Specify in the docstrings the shapes of the input arrays of the functions of the file ctw.py #488

Closed YannCabanes closed 11 months ago

YannCabanes commented 11 months ago

Specify the possible shapes of the input arrays of the metric functions of the file ctw.py in the docstrings. For example:

s1 : array-like, shape=(sz1, d) or (sz1,)
    A time series. If shape is (sz1,), the time series is assumed to be univariate.

or

dataset1 : array-like, shape=(n_ts, sz, d) or (n_ts, sz) or (sz,)
    A dataset of time series. If shape is (n_ts, sz), the dataset is composed of univariate time series. 
    If shape is (sz,), the dataset is a composed of a unique univariate time series.