logos

gagolews · Nov 1, 2023 · a6b21d8 · a6b21d8
1 parent 4f9f7c4
commit a6b21d8
Show file tree

Hide file tree

Showing 23 changed files with 88 additions and 100 deletions.
diff --git a/.devel/sphinx/conf.py b/.devel/sphinx/conf.py
@@ -14,6 +14,7 @@
 pkg_version = clustbench.__version__
 copyright_year = '2020–2023'
 html_baseurl = "https://clustering-benchmarks.gagolewski.com/"
+html_logo = "https://www.gagolewski.com/_static/img/clustbench.png"
 github_url = "https://github.com/gagolews/clustering-benchmarks/"
 github_star_repo = "gagolews/clustering-benchmarks"  # or None to disable
 analytics_id = None  # don't use it! this site does not track its users

diff --git a/.devel/sphinx/index.md b/.devel/sphinx/index.md
@@ -123,6 +123,7 @@ to each dataset.
 ::::{toctree}
 :maxdepth: 2
 :caption: Methodology
+:hidden:
 
 Introduction <self>
 weave/true-vs-predicted
@@ -134,6 +135,7 @@ weave/many-partitions
 ::::{toctree}
 :maxdepth: 2
 :caption: Benchmark Batteries
+:hidden:
 
 weave/suite-v1
 weave/data-v1
@@ -143,9 +145,11 @@ weave/how-to-access
 weave/contributing
 ::::
 
+
 ::::{toctree}
 :maxdepth: 1
 :caption: Python API
+:hidden:
 
 weave/clustbench-usage
 clustbench-documentation
@@ -157,6 +161,7 @@ PyPI Entry <https://pypi.org/project/clustering-benchmarks>
 ::::{toctree}
 :maxdepth: 1
 :caption: See Also
+:hidden:
 
 Author's Homepage <https://www.gagolewski.com/>
 Data Wrangling in Python <https://datawranglingpy.gagolewski.com/>
@@ -168,6 +173,7 @@ genieclust Package <https://genieclust.gagolewski.com/>
 ::::{toctree}
 :maxdepth: 1
 :caption: Appendix
+:hidden:
 
 weave/colouriser
 weave/external-validity-measures

diff --git a/docs/clustbench-documentation.html b/docs/clustbench-documentation.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="index.html">Clustering Benchmarks</a>
@@ -840,7 +843,7 @@ <h1>Documentation<a class="headerlink" href="#documentation" title="Link to this
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -158,6 +158,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="index.html">Clustering Benchmarks</a>
@@ -395,7 +398,7 @@ <h2>T</h2>
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/index.html b/docs/index.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="#"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="#">Clustering Benchmarks</a>
@@ -342,93 +345,14 @@ <h1>A Framework for Benchmarking Clustering Algorithms<a class="headerlink" href
 references mentioned in the description files corresponding
 to each dataset.</p>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">Methodology</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="weave/true-vs-predicted.html">True vs Predicted Clusters</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/true-vs-predicted.html#data">Data</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/true-vs-predicted.html#reference-labels">Reference Labels</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/true-vs-predicted.html#predicted-labels">Predicted Labels</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/true-vs-predicted.html#permuting-cluster-ids">Permuting Cluster IDs</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/true-vs-predicted.html#confusion-matrix">Confusion Matrix</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/true-vs-predicted.html#external-cluster-validity-measures">External Cluster Validity Measures</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="weave/noise-points.html">Noise Points</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/noise-points.html#example">Example</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/noise-points.html#discovering-clusters">Discovering Clusters</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/noise-points.html#evaluating-similarity">Evaluating Similarity</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="weave/many-partitions.html">There Can Be Many Valid Partitions</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/many-partitions.html#alternative-labellings">Alternative Labellings</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/many-partitions.html#predicted-vs-best-matching-reference-labelling">Predicted vs Best-Matching Reference Labelling</a></li>
-</ul>
-</li>
-</ul>
 </div>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">Benchmark Batteries</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="weave/suite-v1.html">Benchmark Suite (v1.1.0)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#wut"><code class="docutils literal notranslate"><span class="pre">wut</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#sipu"><code class="docutils literal notranslate"><span class="pre">sipu</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#fcps"><code class="docutils literal notranslate"><span class="pre">fcps</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#graves"><code class="docutils literal notranslate"><span class="pre">graves</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#other"><code class="docutils literal notranslate"><span class="pre">other</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#uci"><code class="docutils literal notranslate"><span class="pre">uci</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#mnist"><code class="docutils literal notranslate"><span class="pre">mnist</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#g2mg"><code class="docutils literal notranslate"><span class="pre">g2mg</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/suite-v1.html#h2mg"><code class="docutils literal notranslate"><span class="pre">h2mg</span></code></a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="weave/data-v1.html">Explore Datasets (v1.1.0)</a></li>
-<li class="toctree-l1"><a class="reference internal" href="weave/results-v1.html">Clustering Results Repository (v1.1.0)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/results-v1.html#methods">Methods</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/results-v1.html#feature-engineering">Feature Engineering</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="weave/file-format.html">File Format Specification</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/file-format.html#benchmark-datasets">Benchmark Datasets</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/file-format.html#clustering-results">Clustering Results</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="weave/how-to-access.html">Access from Python, R, MATLAB, etc.</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="weave/how-to-access.html#python">Python</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/how-to-access.html#r">R</a></li>
-<li class="toctree-l2"><a class="reference internal" href="weave/how-to-access.html#matlab">MATLAB</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="weave/contributing.html">Contributing</a></li>
-</ul>
 </div>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="weave/clustbench-usage.html">Using <em>clustbench</em></a></li>
-<li class="toctree-l1"><a class="reference internal" href="clustbench-documentation.html">Documentation</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://github.com/gagolews/clustering-benchmarks">Source Code (GitHub)</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/clustering-benchmarks">PyPI Entry</a></li>
-</ul>
 </div>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">See Also</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference external" href="https://www.gagolewski.com/">Author's Homepage</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://datawranglingpy.gagolewski.com/">Data Wrangling in Python</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://deepr.gagolewski.com">Deep R Programming</a></li>
-<li class="toctree-l1"><a class="reference external" href="https://genieclust.gagolewski.com/">genieclust Package</a></li>
-</ul>
 </div>
 <div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="weave/colouriser.html">Colouriser: A Planar Data Editor</a></li>
-<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"><a class="reference internal" href="news.html">Changelog</a></li>
-<li class="toctree-l1"><a class="reference internal" href="z_bibliography.html">References</a></li>
-</ul>
 </div>
 </section>
 
@@ -457,7 +381,7 @@ <h1>A Framework for Benchmarking Clustering Algorithms<a class="headerlink" href
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/news.html b/docs/news.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="index.html">Clustering Benchmarks</a>
@@ -336,7 +339,7 @@ <h2>0.0.0 (2015-12-29)<a class="headerlink" href="#id5" title="Link to this head
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -158,6 +158,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="index.html">Clustering Benchmarks</a>
@@ -277,7 +280,7 @@ <h1>Python Module Index</h1>
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/search.html b/docs/search.html
@@ -157,6 +157,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="index.html">Clustering Benchmarks</a>
@@ -268,7 +271,7 @@
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/weave/clustbench-usage.html b/docs/weave/clustbench-usage.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="../index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="../index.html">Clustering Benchmarks</a>
@@ -480,7 +483,7 @@ <h2>Applying Clustering Methods Manually<a class="headerlink" href="#applying-cl
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/weave/colouriser.html b/docs/weave/colouriser.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="../index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="../index.html">Clustering Benchmarks</a>
@@ -312,7 +315,7 @@
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/weave/contributing.html b/docs/weave/contributing.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="../index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="../index.html">Clustering Benchmarks</a>
@@ -301,7 +304,7 @@
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/weave/data-v1.html b/docs/weave/data-v1.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="../index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="../index.html">Clustering Benchmarks</a>
@@ -480,7 +483,7 @@
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>

diff --git a/docs/weave/external-validity-measures.html b/docs/weave/external-validity-measures.html
@@ -160,6 +160,9 @@
     <div class="sidebar-container">
 
       <div class="sidebar-sticky">
+<div class="sidebar-logo-container">
+  <a class="sidebar-brand" href="../index.html"><img class="sidebar-logo" src="https://www.gagolewski.com/_static/img/clustbench.png" alt="Logo"/></a>
+</div>
 
 <span class="sidebar-brand-text">
 <a class="sidebar-brand" href="../index.html">Clustering Benchmarks</a>
@@ -694,7 +697,7 @@ <h2>Information-Theoretic Measures<a class="headerlink" href="#information-theor
               Some rights reserved. Licensed under <a href='https://creativecommons.org/licenses/by-nc-nd/4.0/'>CC BY-NC-ND 4.0</a>.
               Built with <a href="https://sphinx-doc.org/">Sphinx</a>
               and a customised <a href="https://github.com/pradyunsg/furo">Furo</a> theme.
-              Last updated on 2023-10-29T14:39:43+1100.
+              Last updated on 2023-11-01T12:10:40+1100.
               This site will never display any ads: it is a non-profit project.
               It does not collect any data.
             </div>