Documentation error in dtw_ndim.distance

[dieJaegerIn]

Hi,

I believe there is an error in the documentation for the function dtaidistance.dtw_ndim.distance.

The current documentation states:

Assumes the first dimension to be the sequence item index, and the second dimension to be the series index (thus timestep).

However, in the example for independent DTW the loop calculates dtw between the dimensions individually: s1[:, dim] and s2[:, dim], where the first dimension represents the timesteps. Because of this, I'm a bit confused about the shape of the input arrays.

Additionally, the example code for independent DTW does not work as written:

dtw_i = 0
for dim in range(ndim):
    dtw_i += dtw.distance(s1[:, dim], dtw.distance(s2[:, dim]))

I believe it should be:

dtw_i += dtw.distance(s1[:, dim], s2[:, dim])

Thank you for looking into this!