Skip to content

[MRG] Fix inaccurate SCML doctring for 'triplet_diffs' option #351

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

Merged
merged 1 commit into from
Jun 21, 2022
Merged

[MRG] Fix inaccurate SCML doctring for 'triplet_diffs' option #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions metric_learn/scml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,9 +328,10 @@ class SCML(_BaseSCML, _TripletsClassifierMixin):
'triplet_diffs', and an array-like of shape (n_basis, n_features).

'triplet_diffs'
The basis set is constructed from the differences between points of
`n_basis` positive or negative pairs taken from the triplets
constrains.
The basis set is constructed iteratively from differences between points
of `n_features` positive or negative pairs randomly sampled from the
triplets constraints. Requires the number of training triplets to be
great or equal to `n_features`.

array-like
A matrix of shape (n_basis, n_features), that will be used as
Expand Down