metric-learn contains efficient Python implementations of several popular supervised and weakly-supervised metric learning algorithms. As part of scikit-learn-contrib, the API of metric-learn is compatible with scikit-learn, the leading library for machine learning in Python. This allows to use all the scikit-learn routines (for pipelining, model selection, etc) with metric learning algorithms through a unified interface.
Algorithms
- Large Margin Nearest Neighbor (LMNN)
- Information Theoretic Metric Learning (ITML)
- Sparse Determinant Metric Learning (SDML)
- Least Squares Metric Learning (LSML)
- Neighborhood Components Analysis (NCA)
- Local Fisher Discriminant Analysis (LFDA)
- Relative Components Analysis (RCA)
- Metric Learning for Kernel Regression (MLKR)
- Mahalanobis Metric for Clustering (MMC)
Dependencies
- Python 2.7+, 3.4+
- numpy, scipy, scikit-learn>=0.20.3
Optional dependencies
- For SDML, using skggm will allow the algorithm to solve problematic cases
(install from commit a0ed406).
pip install 'git+https://github.com/skggm/skggm.git@a0ed406586c4364ea3297a658f415e13b5cbdaf8'to install the required version of skggm from GitHub. - For running the examples only: matplotlib
Installation/Setup
Run pip install metric-learn to download and install from PyPI.
Run python setup.py install for default installation.
Run pytest test to run all tests (you will need to have the pytest
package installed).
Usage
See the sphinx documentation for full documentation about installation, API, usage, and examples.
Citation
If you use metric-learn in a scientific publication, we would appreciate citations to the following paper:
metric-learn: Metric Learning Algorithms in Python, de Vazelhes et al., arXiv:1908.04710, 2019.
Bibtex entry:
@techreport{metric-learn,
title = {metric-learn: {M}etric {L}earning {A}lgorithms in {P}ython},
author = {{de Vazelhes}, William and {Carey}, CJ and {Tang}, Yuan and
{Vauquier}, Nathalie and {Bellet}, Aur{\'e}lien},
institution = {arXiv:1908.04710},
year = {2019}
}