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

Document cdist's/pdist's keyword arguments V, VI, and w #69

Merged
merged 6 commits into from
Oct 6, 2017
Merged

Document cdist's/pdist's keyword arguments V, VI, and w #69

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
054bfed
Doc cdist's keyword argument V
jakirkham Oct 6, 2017
f3a62ed
Doc pdist's keyword argument V
jakirkham Oct 6, 2017
0ff6d32
Doc cdist's keyword argument VI
jakirkham Oct 6, 2017
4b9a1d7
Doc pdist's keyword argument VI
jakirkham Oct 6, 2017
e9b89ae
Doc cdist's keyword argument w
jakirkham Oct 6, 2017
f487978
Doc pdist's keyword argument w
jakirkham Oct 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions dask_distance/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ def cdist(XA, XB, metric="euclidean", **kwargs):

Keyword Args:
p: p-norm for minkowski only (default: 2)
V: 1-D array of variances for seuclidean only
(default: estimated from XA and XB)
VI: Inverse of the covariance matrix for mahalanobis only
(default: estimated from XA and XB)
w: 1-D array of weights for wminkowski only (required)

Returns:
array: distance between each combination of points
Expand Down Expand Up @@ -129,6 +134,11 @@ def pdist(X, metric="euclidean", **kwargs):

Keyword Args:
p: p-norm for minkowski only (default: 2)
V: 1-D array of variances for seuclidean only
(default: estimated from X)
VI: Inverse of the covariance matrix for mahalanobis only
(default: estimated from X)
w: 1-D array of weights for wminkowski only (required)

Returns:
array: condensed distance between each pair
Expand Down