Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gagolews committed Oct 6, 2022
1 parent 3459601 commit e469654
Show file tree
Hide file tree
Showing 53 changed files with 64 additions and 52 deletions.
5 changes: 5 additions & 0 deletions .devel/sphinx/news.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 1.1.1 (2022-10-06)

- [BUGFIX] #3: `root_dir` in `glob.glob` is only available Python >= 3.10.


## 1.1.0 (2022-09-17)

- The project's homepage was created. It is available at
Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/many-partitions-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/many-partitions-genie-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/partition-similarity-example-2-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/partition-similarity-example-2b-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/partition-similarity-example-4-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/partition-similarity-noise-data-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/partition-similarity-noise-genie-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/using-clustbench-example1-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/using-clustbench-example2-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/using-clustbench-example3-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.1.0',
VERSION: '1.1.1',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
8 changes: 4 additions & 4 deletions docs/clustbench-documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -403,7 +403,7 @@ <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>path</strong></dt><dd><p>Path to the directory containing the downloaded benchmark datasets
<dt><strong>path</strong></dt><dd><p>Path to the directory containing the downloaded benchmark dataset
suite. Defaults to the current working directory.</p>
</dd>
<dt><strong>expanduser</strong></dt><dd><p>Whether to call <code class="docutils literal notranslate"><span class="pre">os.path.expanduser</span></code> on the file path.</p>
Expand Down Expand Up @@ -440,7 +440,7 @@ <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to
Can be an empty string or <code class="docutils literal notranslate"><span class="pre">&quot;.&quot;</span></code> if all files are
in a single directory as specified by <cite>path</cite>.</p>
</dd>
<dt><strong>path</strong></dt><dd><p>Path to the directory containing the downloaded benchmark datasets
<dt><strong>path</strong></dt><dd><p>Path to the directory containing the downloaded benchmark dataset
suite. Defaults to the current working directory.</p>
</dd>
<dt><strong>expanduser</strong></dt><dd><p>Whether to call <code class="docutils literal notranslate"><span class="pre">os.path.expanduser</span></code> on the file path.</p>
Expand Down Expand Up @@ -807,7 +807,7 @@ <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -365,7 +365,7 @@ <h2 id="T">T</h2>
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -428,7 +428,7 @@ <h1>A Framework for Benchmarking Clustering Algorithms<a class="headerlink" href
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
27 changes: 17 additions & 10 deletions docs/news.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -149,9 +149,10 @@
<li class="toctree-l1"><a class="reference internal" href="weave/external-validity-measures.html">External Cluster Validity Measures</a></li>
<li class="toctree-l1"><a class="reference internal" href="weave/internal-validity-measures.html">Side Note: Internal <em>(In)Validity</em> Measures</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">1.1.0 (2022-09-17)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">1.0.0 (2020-05-08)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">0.0.0 (2015-12-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">1.1.1 (2022-10-06)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">1.1.0 (2022-09-17)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">1.0.0 (2020-05-08)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id4">0.0.0 (2015-12-29)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="z_bibliography.html">References</a></li>
Expand Down Expand Up @@ -239,7 +240,13 @@
<section class="tex2jax_ignore mathjax_ignore" id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading"></a></h1>
<section id="id1">
<h2>1.1.0 (2022-09-17)<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<h2>1.1.1 (2022-10-06)<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>[BUGFIX] #3: <code class="docutils literal notranslate"><span class="pre">root_dir</span></code> in <code class="docutils literal notranslate"><span class="pre">glob.glob</span></code> is only available Python &gt;= 3.10.</p></li>
</ul>
</section>
<section id="id2">
<h2>1.1.0 (2022-09-17)<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>The project’s homepage was created. It is available at
<a class="reference external" href="https://clustering-benchmarks.gagolewski.com">https://clustering-benchmarks.gagolewski.com</a>.</p></li>
Expand All @@ -250,16 +257,16 @@ <h2>1.1.0 (2022-09-17)<a class="headerlink" href="#id1" title="Permalink to this
<a class="reference external" href="https://github.com/gagolews/clustering-results-v1">https://github.com/gagolews/clustering-results-v1</a>.</p></li>
</ul>
</section>
<section id="id2">
<h2>1.0.0 (2020-05-08)<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h2>
<section id="id3">
<h2>1.0.0 (2020-05-08)<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Datasets in the 1st (v1.0.0) version of the benchmark
battery are now frozen. The historical snapshot is available at
DOI: <a class="reference external" href="https://doi.org/10.5281/zenodo.3815066">10.5281/zenodo.3815066</a>.</p></li>
</ul>
</section>
<section id="id3">
<h2>0.0.0 (2015-12-29)<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h2>
<section id="id4">
<h2>0.0.0 (2015-12-29)<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Version 0 of the benchmark battery consists of the datasets
studied in: Gagolewski M., Bartoszuk M., Cena A.,
Expand Down Expand Up @@ -293,7 +300,7 @@ <h2>0.0.0 (2015-12-29)<a class="headerlink" href="#id3" title="Permalink to this
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -260,7 +260,7 @@ <h1>Python Module Index</h1>
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -250,7 +250,7 @@
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/weave/clustbench-usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -442,7 +442,7 @@ <h2>Applying Clustering Methods Manually<a class="headerlink" href="#applying-cl
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/colouriser.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -278,7 +278,7 @@
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -266,7 +266,7 @@
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/data-v1.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -444,7 +444,7 @@
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/external-validity-measures.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -668,7 +668,7 @@ <h2>Information-Theoretic Measures<a class="headerlink" href="#information-theor
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/file-format.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -340,7 +340,7 @@ <h2>Clustering Results<a class="headerlink" href="#clustering-results" title="Pe
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/how-to-access.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -344,7 +344,7 @@ <h2>MATLAB<a class="headerlink" href="#matlab" title="Permalink to this heading"
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/internal-validity-measures.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -489,7 +489,7 @@ <h2>Generalised Dunn Indices<a class="headerlink" href="#generalised-dunn-indice
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/many-partitions.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -352,7 +352,7 @@ <h2>Predicted vs Best-Matching Reference Labelling<a class="headerlink" href="#p
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/noise-points.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -394,7 +394,7 @@ <h2>Evaluating Similarity<a class="headerlink" href="#evaluating-similarity" tit
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
4 changes: 2 additions & 2 deletions docs/weave/results-v1.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
</a>

<div class="version">
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.0
by <a style="color: inherit" href="https://www.gagolewski.com">Marek Gagolewski</a><br />v1.1.1
</div>

<!--
Expand Down Expand Up @@ -315,7 +315,7 @@ <h2>Feature Engineering<a class="headerlink" href="#feature-engineering" title="
and a customised <a href="https://github.com/rtfd/sphinx_rtd_theme">rtd</a>
theme.
<span class="lastupdated">
Last updated on 2022-09-22T18:47:01+1000.
Last updated on 2022-10-06T12:10:39+1100.
</span>


Expand Down
Loading

0 comments on commit e469654

Please sign in to comment.