Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] adds missing import statements in numba distance docstrings #4376

Merged
merged 7 commits into from Mar 29, 2023
Merged

[DOC] adds missing import statements in numba distance docstrings #4376

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a129c8f
[AUTOMATED] update CONTRIBUTORS.md
JonathanBechtel Jan 17, 2023
2f5404a
updated contributors.md
JonathanBechtel Mar 17, 2023
59eee9f
added missing imports for distance calculations
JonathanBechtel Mar 17, 2023
984cc15
added imports to docstring examples
JonathanBechtel Mar 21, 2023
24f5370
concluding merge
JonathanBechtel Mar 21, 2023
add0189
Update CONTRIBUTORS.md
JonathanBechtel Mar 21, 2023
6685e7c
Merge branch 'main' into pr/4376
fkiraly Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions sktime/distances/_distance.py
View file
Open in desktop
Expand Up @@ -91,6 +91,8 @@ def erp_distance(

Examples
--------
>>> import numpy as np
>>> from sktime.distances import erp_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> erp_distance(x_1d, y_1d)
Expand Down Expand Up @@ -183,6 +185,8 @@ def edr_distance(

Examples
--------
>>> import numpy as np
>>> from sktime.distances import edr_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> edr_distance(x_1d, y_1d)
Expand Down Expand Up @@ -370,6 +374,8 @@ def wddtw_distance(

Examples
--------
>>> import numpy as np
>>> from sktime.distances import wddtw_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> wddtw_distance(x_1d, y_1d) # doctest: +SKIP
Expand Down Expand Up @@ -473,6 +479,8 @@ def wdtw_distance(

Examples
--------
>>> import numpy as np
>>> from sktime.distances import wdtw_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> wdtw_distance(x_1d, y_1d)
Expand Down Expand Up @@ -572,6 +580,7 @@ def ddtw_distance(
Examples
--------
>>> import numpy as np
>>> from sktime.distances import ddtw_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> ddtw_distance(x_1d, y_1d) # doctest: +SKIP
Expand Down Expand Up @@ -893,6 +902,7 @@ def twe_distance(
Examples
--------
>>> import numpy as np
>>> from sktime.distances import twe_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> twe_distance(x_1d, y_1d)
Expand Down Expand Up @@ -959,6 +969,7 @@ def squared_distance(x: np.ndarray, y: np.ndarray, **kwargs: Any) -> float:
Examples
--------
>>> import numpy as np
>>> from sktime.distances import squared_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> squared_distance(x_1d, y_1d)
Expand Down Expand Up @@ -1012,6 +1023,7 @@ def euclidean_distance(x: np.ndarray, y: np.ndarray, **kwargs: Any) -> float:
Examples
--------
>>> import numpy as np
>>> from sktime.distances import euclidean_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> euclidean_distance(x_1d, y_1d)
Expand Down Expand Up @@ -1922,6 +1934,7 @@ def distance(
Examples
--------
>>> import numpy as np
>>> from sktime.distances import distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> distance(x_1d, y_1d, metric='dtw')
Expand Down Expand Up @@ -2095,6 +2108,7 @@ def pairwise_distance(
Examples
--------
>>> import numpy as np
>>> from sktime.distances import pairwise_distance
>>> x_1d = np.array([1, 2, 3, 4]) # 1d array
>>> y_1d = np.array([5, 6, 7, 8]) # 1d array
>>> pairwise_distance(x_1d, y_1d, metric='dtw')
Expand Down