Skip to content

Commit 605b4ad

Browse files
Adding a link to the docs
[ci skip]
1 parent d8726d3 commit 605b4ad

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Run ``python setup.py test`` to run all tests.
3131

3232
**Usage**
3333

34-
For full usage examples, see the ``test`` and ``examples`` directories.
34+
For full usage examples, see the `sphinx documentation`_.
3535

3636
Each metric is a subclass of ``BaseMetricLearner``, which provides
3737
default implementations for the methods ``metric``, ``transformer``, and
@@ -45,7 +45,7 @@ expressed ``(x-y).dot(M).dot(x-y)``.
4545

4646
In the same scenario, ``foo.transformer()`` returns a ``d`` by ``d``
4747
matrix ``L`` such that a vector ``x`` can be represented in the learned
48-
space as the vector ``L.dot(x)``.
48+
space as the vector ``x.dot(L.T)``.
4949

5050
For convenience, the function ``foo.transform(X)`` is provided for
5151
converting a matrix of points (``X``) into the learned space, in which
@@ -64,9 +64,11 @@ more complete.
6464

6565
.. _this site: http://www.cs.cmu.edu/~liuy/distlearn.htm
6666

67+
.. _sphinx documentation: http://all-umass.github.io/metric-learn/
68+
6769
.. |Travis-CI Build Status| image:: https://api.travis-ci.org/all-umass/metric-learn.svg?branch=master
6870
:target: https://travis-ci.org/all-umass/metric-learn
6971
.. |License| image:: http://img.shields.io/:license-mit-blue.svg?style=flat
7072
:target: http://badges.mit-license.org
7173
.. |PyPI version| image:: https://badge.fury.io/py/metric-learn.svg
72-
:target: http://badge.fury.io/py/metric-learn
74+
:target: http://badge.fury.io/py/metric-learn

0 commit comments

Comments
 (0)