Skip to content

Commit

Permalink
deploy: 75466c3
Browse files Browse the repository at this point in the history
  • Loading branch information
@PhilipMay
PhilipMay committed May 24, 2024
1 parent d61d519 commit c5315f9
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions api-reference/data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mltb2_base_data_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> | </em><em>None</em>) – The base data directory. If <code class="docutils literal notranslate"><span class="pre">None</span></code> the default
user data directory is used. The default user data directory is
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev1+g12cc712)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev2+g2f7aecf)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Tuple containing labels and data.</p>
Expand All @@ -184,7 +184,7 @@
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mltb2_base_data_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> | </em><em>None</em>) – The base data directory. If <code class="docutils literal notranslate"><span class="pre">None</span></code> the default
user data directory is used. The default user data directory is
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev1+g12cc712)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev2+g2f7aecf)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Tuple containing labels and data.</p>
Expand All @@ -204,7 +204,7 @@
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mltb2_base_data_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> | </em><em>None</em>) – The base data directory. If <code class="docutils literal notranslate"><span class="pre">None</span></code> the default
user data directory is used. The default user data directory is
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev1+g12cc712)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev2+g2f7aecf)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Tuple containing labels and data.</p>
Expand Down
2 changes: 1 addition & 1 deletion api-reference/files.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>mltb2_base_data_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> | </em><em>None</em>) – The base data directory. If <code class="docutils literal notranslate"><span class="pre">None</span></code> the default
user data directory is used. The default user data directory is
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev1+g12cc712)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
determined by <a class="reference external" href="https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs.user_data_dir" title="(in platformdirs v4.2.3.dev2+g2f7aecf)"><code class="xref py py-func docutils literal notranslate"><span class="pre">platformdirs.user_data_dir()</span></code></a>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The directory path.</p>
Expand Down
2 changes: 1 addition & 1 deletion api-reference/text.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
<dt class="sig sig-object py" id="mltb2.text.TextDistance.distance">
<span class="sig-name descname"><span class="pre">distance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span></span><a class="reference internal" href="../_modules/mltb2/text.html#TextDistance.distance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mltb2.text.TextDistance.distance" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the distance between the fitted text and the given text.</p>
<p>This implementation uses the Manhattan distance (<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.cityblock.html#scipy.spatial.distance.cityblock" title="(in SciPy v1.13.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.spatial.distance.cityblock()</span></code></a>).
<p>This implementation uses the Manhattan distance (<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.cityblock.html#scipy.spatial.distance.cityblock" title="(in SciPy v1.13.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.spatial.distance.cityblock()</span></code></a>).
The distance is only calculated for <code class="docutils literal notranslate"><span class="pre">max_dimensions</span></code> most commen characters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down

0 comments on commit c5315f9

Please sign in to comment.