Skip to content

Commit 70c48fd

Browse files
Callidiorperimosocordiae
authored andcommitted
Clarified documentation of ITML (resolves #58) (#59)
1 parent 238be72 commit 70c48fd

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

metric_learn/itml.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ def fit(self, X, constraints, bounds=None):
8080
X : (n x d) data matrix
8181
each row corresponds to a single instance
8282
constraints : 4-tuple of arrays
83-
(a,b,c,d) indices into X, such that d(X[a],X[b]) < d(X[c],X[d])
83+
(a,b,c,d) indices into X, with (a,b) specifying positive and (c,d)
84+
negative pairs
8485
bounds : list (pos,neg) pairs, optional
8586
bounds on similarity, s.t. d(X[a],X[b]) < pos and d(X[c],X[d]) > neg
8687
"""

0 commit comments

Comments
 (0)