Rebuilds the documentation html files

DIDSR · Jun 29, 2024 · 282c2c0 · 282c2c0
1 parent 65515a7
commit 282c2c0
Show file tree

Hide file tree

Showing 96 changed files with 1,262 additions and 134 deletions.
diff --git a/README.md b/README.md
@@ -5,10 +5,9 @@
 DomId is a Python package offering a PyTorch-based suite of unsupervised deep clustering algorithms. The primary goal is to identify subgroups that have not been previously annotated within image datasets.
 
 Some of the implemented models are the Variational Deep Embedding (VaDE) model [Jiang et al., 2017], Conditionally Decoded Variational Deep Embedding (CDVaDE) [Sidulova et al., 2023], Deep Embedding Clustering (DEC) [Xie et al., 2016], Structural Deep Clustering Network (SDCN) [Bo et al., 2020].
-
 These clustering algorithms include a feature extractor component, which can be either an Autoencoders (AE) or a Variational Autoencoder (VAE). The package provides multiple AE and VAE architectures to choose from and includes instructions for extending the package with custom neural network architectures or clustering algorithms.
 
-Ready-to-use experiment tutorials in Jupyter notebooks are available for both the MNIST dataset and a digital pathology dataset.
+Experiment tutorials in Jupyter notebooks are available for both the MNIST dataset and a digital pathology dataset.
 
 By adopting a highly modular design, the codebase prioritizes straightforward extensibility, so that new models, datasets or tasks can be added with ease.
 The software design of DomId follows the design principles of [DomainLab](https://github.com/marrlab/DomainLab), which is a modular Python package for training domain invariant neural networks and has been used to develop DomId.
@@ -29,7 +28,7 @@ poetry install
 
 ## Usage
 
-The following examples demonstrate how to use the DomId Python package directly from your command line. You can also leverage its API within your Python scripts or notebooks for greater flexibility. For in-depth tutorials and case studies, please refer to the `notebooks` directory.
+The following examples demonstrate how to use the DomId Python package directly from your command line. You can also leverage its API within your Python scripts or notebooks for greater flexibility. For in-depth tutorials and case studies, please refer to the [`notebooks` directory](https://github.com/DIDSR/DomId/tree/main/notebooks).
 
 ### VaDE model
 

diff --git a/docs/build/doctrees/about.doctree b/docs/build/doctrees/about.doctree
diff --git a/docs/build/doctrees/about_link.doctree b/docs/build/doctrees/about_link.doctree
diff --git a/docs/build/doctrees/addnew_link.doctree b/docs/build/doctrees/addnew_link.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/readme_link.doctree b/docs/build/doctrees/readme_link.doctree
diff --git a/docs/build/html/_modules/domid/algos/builder_ae.html b/docs/build/html/_modules/domid/algos/builder_ae.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/algos/builder_dec.html b/docs/build/html/_modules/domid/algos/builder_dec.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/algos/builder_m2yd.html b/docs/build/html/_modules/domid/algos/builder_m2yd.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/algos/builder_sdcn.html b/docs/build/html/_modules/domid/algos/builder_sdcn.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/algos/builder_vade.html b/docs/build/html/_modules/domid/algos/builder_vade.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/algos/zoo_algos.html b/docs/build/html/_modules/domid/algos/zoo_algos.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/arg_parser.html b/docs/build/html/_modules/domid/arg_parser.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/DEC_clustering_layer.html b/docs/build/html/_modules/domid/compos/DEC_clustering_layer.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/GNN.html b/docs/build/html/_modules/domid/compos/GNN.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/GNN_layer.html b/docs/build/html/_modules/domid/compos/GNN_layer.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/VAE_blocks.html b/docs/build/html/_modules/domid/compos/VAE_blocks.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/cnn_AE.html b/docs/build/html/_modules/domid/compos/cnn_AE.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/cnn_VAE.html b/docs/build/html/_modules/domid/compos/cnn_VAE.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/linear_AE.html b/docs/build/html/_modules/domid/compos/linear_AE.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/linear_VAE.html b/docs/build/html/_modules/domid/compos/linear_VAE.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/nn_net.html b/docs/build/html/_modules/domid/compos/nn_net.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/predict_basic.html b/docs/build/html/_modules/domid/compos/predict_basic.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">

diff --git a/docs/build/html/_modules/domid/compos/tensorboard_fun.html b/docs/build/html/_modules/domid/compos/tensorboard_fun.html
@@ -209,7 +209,19 @@
   <ul class="md-nav__list">
     <li class="md-nav__item">
 
-      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+      <span class="md-nav__link caption"><span class="caption-text">Introduction and Quick Start guide:</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../readme_link.html" class="md-nav__link">Introduction</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models:</span></span>
 
     </li>
     <li class="md-nav__item">