Skip to content

Commit

Permalink
fix dependencies doc and add pointer to v0.5.0 for earlier Python ver…
Browse files Browse the repository at this point in the history
…sions (#298)
  • Loading branch information
bellet authored Jul 1, 2020
1 parent a3435f3 commit 3e1af68
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ metric-learn contains efficient Python implementations of several popular superv

**Dependencies**

- Python 3.6+
- Python 3.6+ (the last version supporting Python 2 and Python 3.5 was
`v0.5.0 <https://pypi.org/project/metric-learn/0.5.0/>`_)
- numpy, scipy, scikit-learn>=0.20.3

**Optional dependencies**
Expand Down
7 changes: 4 additions & 3 deletions doc/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,16 @@ metric-learn can be installed in either of the following ways:

**Dependencies**

- Python 2.7+, 3.4+
- numpy, scipy, scikit-learn>=0.20.3
- Python 3.6+ (the last version supporting Python 2 and Python 3.5 was
`v0.5.0 <https://pypi.org/project/metric-learn/0.5.0/>`_)
- 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 <https://github.com/skggm/skggm/commit/a0ed406586c4364ea3297a658f415e13b5cbdaf8>`_).
``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
- For running the examples only: matplotlib

Quick start
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ examples (for code illustrating some of these use-cases, see the
metric learning provides a way to bias the clusters found by algorithms like
K-Means towards the intended semantics.
- Information retrieval: the learned metric can be used to retrieve the
elements of a database that are semantically closer to a query element.
elements of a database that are semantically closest to a query element.
- Dimensionality reduction: metric learning may be seen as a way to reduce the
data dimension in a (weakly) supervised setting.
- More generally, the learned transformation :math:`L` can be used to project
Expand Down

0 comments on commit 3e1af68

Please sign in to comment.