Skip to content

Commit 76ba4b3

Browse files
author
William de Vazelhes
committed
Update documentation with link to paper
1 parent 1c5d001 commit 76ba4b3

File tree

20 files changed

+53
-25
lines changed

20 files changed

+53
-25
lines changed

.buildinfo

Lines changed: 0 additions & 4 deletions
This file was deleted.
Loading
Loading
3.46 KB
Loading
1.75 KB
Loading

_sources/auto_examples/index.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ Below is a gallery of example metric-learn use cases.
5959
6060
.. container:: sphx-glr-download
6161
62-
:download:`Download all examples in Python source code: auto_examples_python.zip <//home/will/new_repo/metric-learn/doc/auto_examples/auto_examples_python.zip>`
62+
:download:`Download all examples in Python source code: auto_examples_python.zip <//home/will/metric-learn/doc/auto_examples/auto_examples_python.zip>`
6363
6464
6565
6666
.. container:: sphx-glr-download
6767
68-
:download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip <//home/will/new_repo/metric-learn/doc/auto_examples/auto_examples_jupyter.zip>`
68+
:download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip <//home/will/metric-learn/doc/auto_examples/auto_examples_jupyter.zip>`
6969
7070
7171
.. only:: html

_sources/auto_examples/plot_metric_learning_examples.rst.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -683,9 +683,9 @@ Now that we've created our constraints, let's see what it looks like!
683683
[ 0 9]
684684
[ 0 10]
685685
...
686-
[19 2]
687-
[42 40]
688-
[82 41]]
686+
[35 23]
687+
[52 64]
688+
[86 63]]
689689
[ 1. 1. 1. ... -1. -1. -1.]
690690
691691
@@ -744,7 +744,7 @@ metric-learn with scikit-learn estimators.
744744
This brings us to the end of this tutorial! Have fun Metric Learning :)
745745

746746

747-
**Total running time of the script:** ( 1 minutes 19.674 seconds)
747+
**Total running time of the script:** ( 1 minutes 15.365 seconds)
748748

749749

750750
.. _sphx_glr_download_auto_examples_plot_metric_learning_examples.py:

_sources/auto_examples/plot_sandwich.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Sandwich demo based on code from http://nbviewer.ipython.org/6576096
116116
if __name__ == '__main__':
117117
sandwich_demo()
118118
119-
**Total running time of the script:** ( 0 minutes 4.620 seconds)
119+
**Total running time of the script:** ( 0 minutes 4.099 seconds)
120120

121121

122122
.. _sphx_glr_download_auto_examples_plot_sandwich.py:

_sources/index.rst.txt

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,28 @@ contains efficient Python implementations of several popular supervised and
77
weakly-supervised metric learning algorithms. As part of `scikit-learn-contrib
88
<https://github.com/scikit-learn-contrib>`_, the API of metric-learn is compatible with `scikit-learn
99
<https://scikit-learn.org/>`_, the leading library for machine learning in
10-
Python. This allows to use of all the scikit-learn routines (for pipelining,
10+
Python. This allows to use all the scikit-learn routines (for pipelining,
1111
model selection, etc) with metric learning algorithms through a unified
1212
interface.
1313

14+
If you use metric-learn in a scientific publication, we would appreciate
15+
citations to the following paper:
16+
17+
`metric-learn: Metric Learning Algorithms in Python
18+
<https://arxiv.org/abs/1908.04710>`_, de Vazelhes
19+
*et al.*, arXiv:1908.04710, 2019.
20+
21+
Bibtex entry::
22+
23+
@techreport{metric-learn,
24+
title = {metric-learn: {M}etric {L}earning {A}lgorithms in {P}ython},
25+
author = {{de Vazelhes}, William and {Carey}, CJ and {Tang}, Yuan and
26+
{Vauquier}, Nathalie and {Bellet}, Aur{\'e}lien},
27+
institution = {arXiv:1908.04710},
28+
year = {2019}
29+
}
30+
31+
1432
Documentation outline
1533
---------------------
1634

auto_examples/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,9 @@ <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this head
178178
</div>
179179
<div style='clear:both'></div><div class="sphx-glr-footer class sphx-glr-footer-gallery docutils container">
180180
<div class="sphx-glr-download docutils container">
181-
<a class="reference download internal" download="" href="../_downloads/8effe4b984579ff0eb0e570d9d224324/auto_examples_python.zip"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">all</span> <span class="pre">examples</span> <span class="pre">in</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">auto_examples_python.zip</span></code></a></div>
181+
<a class="reference download internal" download="" href="../_downloads/6ba8271a51eacf71a8f143ee6489f1f1/auto_examples_python.zip"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">all</span> <span class="pre">examples</span> <span class="pre">in</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">auto_examples_python.zip</span></code></a></div>
182182
<div class="sphx-glr-download docutils container">
183-
<a class="reference download internal" download="" href="../_downloads/7bad39157ddf73bd946aceb8bc69eac4/auto_examples_jupyter.zip"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">all</span> <span class="pre">examples</span> <span class="pre">in</span> <span class="pre">Jupyter</span> <span class="pre">notebooks:</span> <span class="pre">auto_examples_jupyter.zip</span></code></a></div>
183+
<a class="reference download internal" download="" href="../_downloads/195613ed69dc7de9449134bf862928f9/auto_examples_jupyter.zip"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">all</span> <span class="pre">examples</span> <span class="pre">in</span> <span class="pre">Jupyter</span> <span class="pre">notebooks:</span> <span class="pre">auto_examples_jupyter.zip</span></code></a></div>
184184
</div>
185185
<p class="sphx-glr-signature"><a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a></p>
186186
</div>

auto_examples/plot_metric_learning_examples.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -594,9 +594,9 @@ <h2>Metric Learning from Weaker Supervision<a class="headerlink" href="#metric-l
594594
[ 0 9]
595595
[ 0 10]
596596
...
597-
[19 2]
598-
[42 40]
599-
[82 41]]
597+
[35 23]
598+
[52 64]
599+
[86 63]]
600600
[ 1. 1. 1. ... -1. -1. -1.]
601601
</pre></div>
602602
</div>
@@ -633,12 +633,12 @@ <h2>Metric Learning from Weaker Supervision<a class="headerlink" href="#metric-l
633633
can also look at some <a class="reference internal" href="../introduction.html#use-cases"><span class="std std-ref">use cases</span></a> where you could combine
634634
metric-learn with scikit-learn estimators.</p>
635635
<p>This brings us to the end of this tutorial! Have fun Metric Learning :)</p>
636-
<p><strong>Total running time of the script:</strong> ( 1 minutes 19.674 seconds)</p>
636+
<p><strong>Total running time of the script:</strong> ( 1 minutes 15.365 seconds)</p>
637637
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-metric-learning-examples-py">
638638
<div class="sphx-glr-download docutils container">
639-
<a class="reference download internal" download="" href="../_downloads/1701602fecf66f059913dd6559226da0/plot_metric_learning_examples.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_metric_learning_examples.py</span></code></a></div>
639+
<a class="reference download internal" download="" href="../_downloads/c2f7c5234b8d146a31cab6b296b2c2af/plot_metric_learning_examples.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_metric_learning_examples.py</span></code></a></div>
640640
<div class="sphx-glr-download docutils container">
641-
<a class="reference download internal" download="" href="../_downloads/434a24c66bbfd5f8398470a8c859e27b/plot_metric_learning_examples.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_metric_learning_examples.ipynb</span></code></a></div>
641+
<a class="reference download internal" download="" href="../_downloads/815de750020fca9d37949a373461ee38/plot_metric_learning_examples.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_metric_learning_examples.ipynb</span></code></a></div>
642642
</div>
643643
<p class="sphx-glr-signature"><a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a></p>
644644
</div>

auto_examples/plot_sandwich.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -264,12 +264,12 @@
264264
<span class="n">sandwich_demo</span><span class="p">()</span>
265265
</pre></div>
266266
</div>
267-
<p><strong>Total running time of the script:</strong> ( 0 minutes 4.620 seconds)</p>
267+
<p><strong>Total running time of the script:</strong> ( 0 minutes 4.099 seconds)</p>
268268
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-sandwich-py">
269269
<div class="sphx-glr-download docutils container">
270-
<a class="reference download internal" download="" href="../_downloads/5632643bbb0183e351bf2b4dc2ab7c39/plot_sandwich.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_sandwich.py</span></code></a></div>
270+
<a class="reference download internal" download="" href="../_downloads/4228f005bd3fbc4a86c3ac1e76e0c591/plot_sandwich.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_sandwich.py</span></code></a></div>
271271
<div class="sphx-glr-download docutils container">
272-
<a class="reference download internal" download="" href="../_downloads/2bcf5e32b5d52d84565bc06c5ad91c98/plot_sandwich.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_sandwich.ipynb</span></code></a></div>
272+
<a class="reference download internal" download="" href="../_downloads/1fbc987b969eaee0a05177c2022570ae/plot_sandwich.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_sandwich.ipynb</span></code></a></div>
273273
</div>
274274
<p class="sphx-glr-signature"><a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a></p>
275275
</div>

index.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,23 @@ <h1>metric-learn: Metric Learning in Python<a class="headerlink" href="#metric-l
163163
<p><a class="reference external" href="https://github.com/scikit-learn-contrib/metric-learn">metric-learn</a>
164164
contains efficient Python implementations of several popular supervised and
165165
weakly-supervised metric learning algorithms. As part of <a class="reference external" href="https://github.com/scikit-learn-contrib">scikit-learn-contrib</a>, the API of metric-learn is compatible with <a class="reference external" href="https://scikit-learn.org/">scikit-learn</a>, the leading library for machine learning in
166-
Python. This allows to use of all the scikit-learn routines (for pipelining,
166+
Python. This allows to use all the scikit-learn routines (for pipelining,
167167
model selection, etc) with metric learning algorithms through a unified
168168
interface.</p>
169+
<p>If you use metric-learn in a scientific publication, we would appreciate
170+
citations to the following paper:</p>
171+
<p><a class="reference external" href="https://arxiv.org/abs/1908.04710">metric-learn: Metric Learning Algorithms in Python</a>, de Vazelhes
172+
<em>et al.</em>, arXiv:1908.04710, 2019.</p>
173+
<p>Bibtex entry:</p>
174+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@techreport</span><span class="p">{</span><span class="n">metric</span><span class="o">-</span><span class="n">learn</span><span class="p">,</span>
175+
<span class="n">title</span> <span class="o">=</span> <span class="p">{</span><span class="n">metric</span><span class="o">-</span><span class="n">learn</span><span class="p">:</span> <span class="p">{</span><span class="n">M</span><span class="p">}</span><span class="n">etric</span> <span class="p">{</span><span class="n">L</span><span class="p">}</span><span class="n">earning</span> <span class="p">{</span><span class="n">A</span><span class="p">}</span><span class="n">lgorithms</span> <span class="ow">in</span> <span class="p">{</span><span class="n">P</span><span class="p">}</span><span class="n">ython</span><span class="p">},</span>
176+
<span class="n">author</span> <span class="o">=</span> <span class="p">{{</span><span class="n">de</span> <span class="n">Vazelhes</span><span class="p">},</span> <span class="n">William</span> <span class="ow">and</span> <span class="p">{</span><span class="n">Carey</span><span class="p">},</span> <span class="n">CJ</span> <span class="ow">and</span> <span class="p">{</span><span class="n">Tang</span><span class="p">},</span> <span class="n">Yuan</span> <span class="ow">and</span>
177+
<span class="p">{</span><span class="n">Vauquier</span><span class="p">},</span> <span class="n">Nathalie</span> <span class="ow">and</span> <span class="p">{</span><span class="n">Bellet</span><span class="p">},</span> <span class="n">Aur</span><span class="p">{</span>\<span class="s1">&#39;e}lien},</span>
178+
<span class="n">institution</span> <span class="o">=</span> <span class="p">{</span><span class="n">arXiv</span><span class="p">:</span><span class="mf">1908.04710</span><span class="p">},</span>
179+
<span class="n">year</span> <span class="o">=</span> <span class="p">{</span><span class="mi">2019</span><span class="p">}</span>
180+
<span class="p">}</span>
181+
</pre></div>
182+
</div>
169183
<div class="section" id="documentation-outline">
170184
<h2>Documentation outline<a class="headerlink" href="#documentation-outline" title="Permalink to this headline"></a></h2>
171185
<div class="toctree-wrapper compound">

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)