Skip to content

Commit

Permalink
Doc pdist's keyword arguments V and VI
Browse files Browse the repository at this point in the history
Missed documenting `V` and `VI` when adding support for the `seuclidean`
and `mahalanobis` metrics to `pdist` respectively. So this adds
documentation for these parameters along with a brief explanation of the
default values they can take on if not specified.
  • Loading branch information
jakirkham committed Oct 6, 2017
1 parent 87c2fe9 commit 6af03bf
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions dask_distance/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ def pdist(X, metric="euclidean", **kwargs):
Keyword Args:
p: p-norm for minkowski only (default: 2)
V: 1-D array of variances (default: estimated from X)
VI: Inverse of the covariance matrix
(default: estimated from X)
Returns:
array: condensed distance between each pair
Expand Down

0 comments on commit 6af03bf

Please sign in to comment.