adding visual examples of package features on index page

* the sphinx gallery examples are used to visualize the different features of the library that link to the getting started page
scikit-learn-contrib · Aug 15, 2023 · 9ef24bd · 9ef24bd
1 parent c11fc11
commit 9ef24bd
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 0 deletions.
diff --git a/docs/src/getting-started.rst b/docs/src/getting-started.rst
@@ -8,6 +8,8 @@ our :ref:`installation` instructions for installing ``scikit-matter``.
 For a detailed explaination of the functionalities, please look at the
 :ref:`selection-api`
 
+.. _getting_started-selection:
+
 Features and Samples Selection
 ------------------------------
 
@@ -21,6 +23,8 @@ Notebook Examples
    :start-line: 4
 
 
+.. _getting_started-reconstruction:
+
 Reconstruction Measures
 -----------------------
 
@@ -33,6 +37,8 @@ Notebook Examples
 .. include:: examples/reconstruction/index.rst
    :start-line: 4
 
+.. _getting_started-pcovr:
+
 Principal Covariates Regression
 -------------------------------
 

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -1,5 +1,74 @@
 .. automodule:: skmatter
 
+.. raw:: html
+
+    <div class="container">
+        <div class="row">
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow" style="background-color: transparent">
+                <div class="card-body flex-fill">
+                    <h5 class="card-title">
+
+
+.. only:: html
+
+  .. image:: /examples/selection/images/thumb/sphx_glr_FeatureSelection-WHODataset_thumb.png
+    :alt:
+
+  :ref:`getting_started-selection`
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Supervised and unsupervised selection
+                    methods based on
+                    CUR matrix decomposition and Farthest Point Sampling.</p>
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow" style="background-color: transparent">
+                <div class="card-body flex-fill">
+                    <h5 class="card-title">
+
+.. only:: html
+
+  .. image:: /examples/pcovr/images/thumb/sphx_glr_PCovR_thumb.png
+    :alt:
+
+  :ref:`getting_started-pcovr`
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Utilises a combination between a PCA-like and a LR-like loss
+                    to determine the decomposition matrix to project feature into latent space</p>
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow" style="background-color: transparent">
+                <div class="card-body flex-fill">
+                    <h5 class="card-title">
+
+.. only:: html
+
+  .. image:: /examples/reconstruction/images/thumb/sphx_glr_PlotLFRE_thumb.png
+    :alt:
+
+  :ref:`getting_started-reconstruction`
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Error measures for quantifying the
+                    linear decodable information capacity between features</p>
+                </div>
+                </div>
+            </div>
+        </div>
+    </div>
+    <br>
 .. include:: ../../README.rst
    :start-after: marker-issues
    :end-before: marker-contributing