Skip to content

Commit

Permalink
deploy: 74c3539
Browse files Browse the repository at this point in the history
  • Loading branch information
@hagenw
hagenw committed Feb 28, 2024
1 parent 434c935 commit cdea9de
Show file tree
Hide file tree
Showing 51 changed files with 413 additions and 393 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7544be936d9c497822b4fc681e29ae8d
config: 0a12e1885e9e5b2b3a2938f45fb8dc27
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/api/audmetric.concordance_cc.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.detection_error_tradeoff.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.edit_distance.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.equal_error_rate.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.event_error_rate.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.linkability.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.unweighted_average_bias.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.weighted_confusion_error.doctree
View file
Binary file not shown.
Binary file modified .doctrees/api/audmetric.word_error_rate.doctree
View file
Binary file not shown.
Binary file modified .doctrees/changelog.doctree
View file
Binary file not shown.
Binary file modified .doctrees/contributing.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/index.doctree
View file
Binary file not shown.
359 changes: 172 additions & 187 deletions _modules/audmetric/core/api.html
View file

Large diffs are not rendered by default.

74 changes: 43 additions & 31 deletions _modules/audmetric/core/utils.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].9/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/katex-math.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -65,7 +65,7 @@


<div class="version">
v1.2.0
v1.2.1
</div>


Expand Down Expand Up @@ -156,15 +156,15 @@ <h1>All modules for which code is available</h1>



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/08 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2024/02/28 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2019-2023 audEERING GmbH
&copy; 2019-2024 audEERING GmbH
</p>
</div>

Expand Down
2 changes: 0 additions & 2 deletions _sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. documentation master file
.. include:: ../README.rst

.. toctree::
Expand Down
1 change: 1 addition & 0 deletions _static/pygments.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down
8 changes: 4 additions & 4 deletions api/audmetric.accuracy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].9/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/katex-math.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -67,7 +67,7 @@


<div class="version">
v1.2.0
v1.2.1
</div>


Expand Down Expand Up @@ -228,15 +228,15 @@ <h1>accuracy()<a class="headerlink" href="#accuracy" title="Permalink to this he



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/08 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2024/02/28 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2019-2023 audEERING GmbH
&copy; 2019-2024 audEERING GmbH
</p>
</div>

Expand Down
16 changes: 10 additions & 6 deletions api/audmetric.concordance_cc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].9/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/katex-math.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -67,7 +67,7 @@


<div class="version">
v1.2.0
v1.2.1
</div>


Expand Down Expand Up @@ -168,7 +168,7 @@
<h1>concordance_cc()<a class="headerlink" href="#concordance-cc" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="audmetric.concordance_cc">
<span class="sig-prename descclassname"><span class="pre">audmetric.</span></span><span class="sig-name descname"><span class="pre">concordance_cc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">truth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prediction</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/audmetric/core/api.html#concordance_cc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#audmetric.concordance_cc" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">audmetric.</span></span><span class="sig-name descname"><span class="pre">concordance_cc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">truth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prediction</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_nan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/audmetric/core/api.html#concordance_cc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#audmetric.concordance_cc" title="Permalink to this definition"></a></dt>
<dd><p>Concordance correlation coefficient.</p>
<div class="math">
<span class="katex-display"><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><semantics><mrow><msub><mi>ρ</mi><mi>c</mi></msub><mo>=</mo><mfrac><mrow><mn>2</mn><mi>ρ</mi><msub><mi>σ</mi><mtext>prediction</mtext></msub><msub><mi>σ</mi><mtext>truth</mtext></msub></mrow><mrow><msubsup><mi>σ</mi><mtext>prediction</mtext><mn>2</mn></msubsup><mo>+</mo><msubsup><mi>σ</mi><mtext>truth</mtext><mn>2</mn></msubsup><mo>+</mo><mo stretchy="false">(</mo><msub><mi>μ</mi><mtext>prediction</mtext></msub><mo>−</mo><msub><mi>μ</mi><mtext>truth</mtext></msub><msup><mo stretchy="false">)</mo><mn>2</mn></msup></mrow></mfrac></mrow><annotation encoding="application/x-tex">\rho_c = \frac{2\rho\sigma_\text{prediction}\sigma_\text{truth}}
Expand All @@ -188,6 +188,10 @@ <h1>concordance_cc()<a class="headerlink" href="#concordance-cc" title="Permalin
<dd class="field-odd"><ul class="simple">
<li><p><strong>truth</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – ground truth values</p></li>
<li><p><strong>prediction</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – predicted values</p></li>
<li><p><strong>ignore_nan</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – if <code class="docutils literal notranslate"><span class="pre">True</span></code>
all samples that contain <code class="docutils literal notranslate"><span class="pre">NaN</span></code>
in <code class="docutils literal notranslate"><span class="pre">truth</span></code> or <code class="docutils literal notranslate"><span class="pre">prediction</span></code>
are ignored</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
Expand All @@ -202,7 +206,7 @@ <h1>concordance_cc()<a class="headerlink" href="#concordance-cc" title="Permalin
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">concordance_cc</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span>
<span class="go">0.6666666666666666</span>
<span class="go">0.6666666666666665</span>
</pre></div>
</div>
</dd></dl>
Expand Down Expand Up @@ -232,15 +236,15 @@ <h1>concordance_cc()<a class="headerlink" href="#concordance-cc" title="Permalin



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/08 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2024/02/28 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2019-2023 audEERING GmbH
&copy; 2019-2024 audEERING GmbH
</p>
</div>

Expand Down
8 changes: 4 additions & 4 deletions api/audmetric.confusion_matrix.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].9/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/katex-math.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -67,7 +67,7 @@


<div class="version">
v1.2.0
v1.2.1
</div>


Expand Down Expand Up @@ -227,15 +227,15 @@ <h1>confusion_matrix()<a class="headerlink" href="#confusion-matrix" title="Perm



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/08 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2024/02/28 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2019-2023 audEERING GmbH
&copy; 2019-2024 audEERING GmbH
</p>
</div>

Expand Down
16 changes: 8 additions & 8 deletions api/audmetric.detection_error_tradeoff.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].9/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/katex-math.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -67,7 +67,7 @@


<div class="version">
v1.2.0
v1.2.1
</div>


Expand Down Expand Up @@ -186,13 +186,13 @@ <h1>detection_error_tradeoff()<a class="headerlink" href="#detection-error-trade
<p><code class="docutils literal notranslate"><span class="pre">truth</span></code> may only contain entries like <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">0,</span> <span class="pre">True,</span> <span class="pre">False...]</span></code>,
whereas prediction values
can also contain similarity scores, e.g. <code class="docutils literal notranslate"><span class="pre">[0.8,</span> <span class="pre">0.1,</span> <span class="pre">...]</span></code>.</p>
<p>The implementation is identical with the one provided
by the <a class="reference external" href="https://github.com/manuelaguadomtz/pyeer">pyeer</a> package.</p>
<p>The implementation was inspired by pyeer.eer_stats.calculate_roc but has
been accelerated by using numpy-arrays instead of lists.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>truth</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]]]) – ground truth classes</p></li>
<li><p><strong>prediction</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]]]) – predicted classes or similarity scores</p></li>
<li><p><strong>truth</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]]) – ground truth classes</p></li>
<li><p><strong>prediction</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]]) – predicted classes or similarity scores</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
Expand Down Expand Up @@ -245,15 +245,15 @@ <h1>detection_error_tradeoff()<a class="headerlink" href="#detection-error-trade



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/08 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2024/02/28 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2019-2023 audEERING GmbH
&copy; 2019-2024 audEERING GmbH
</p>
</div>

Expand Down
12 changes: 6 additions & 6 deletions api/audmetric.edit_distance.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected].9/dist/katex.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/katex-math.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -67,7 +67,7 @@


<div class="version">
v1.2.0
v1.2.1
</div>


Expand Down Expand Up @@ -186,8 +186,8 @@ <h1>edit_distance()<a class="headerlink" href="#edit-distance" title="Permalink
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">truth</span> <span class="o">=</span> <span class="s1">&#39;lorem&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">prediction</span> <span class="o">=</span> <span class="s1">&#39;lorm&#39;</span>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">truth</span> <span class="o">=</span> <span class="s2">&quot;lorem&quot;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">prediction</span> <span class="o">=</span> <span class="s2">&quot;lorm&quot;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">edit_distance</span><span class="p">(</span><span class="n">truth</span><span class="p">,</span> <span class="n">prediction</span><span class="p">)</span>
<span class="go">1</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">truth</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span>
Expand Down Expand Up @@ -223,15 +223,15 @@ <h1>edit_distance()<a class="headerlink" href="#edit-distance" title="Permalink



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/08 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2024/02/28 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2019-2023 audEERING GmbH
&copy; 2019-2024 audEERING GmbH
</p>
</div>

Expand Down
Loading

0 comments on commit cdea9de

Please sign in to comment.