From 9ef24bde672a9de0d2c50ad95dac6223169f640d Mon Sep 17 00:00:00 2001 From: Alexander Goscinski Date: Fri, 28 Jul 2023 04:09:22 +0200 Subject: [PATCH] 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 --- docs/src/getting-started.rst | 6 ++++ docs/src/index.rst | 69 ++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) diff --git a/docs/src/getting-started.rst b/docs/src/getting-started.rst index e5e59b1b8..b3a3b3bad 100644 --- 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 index f2ee50cbf..fec268ed3 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -1,5 +1,74 @@ .. automodule:: skmatter +.. raw:: html + +
+
+
+
+
+
+ + +.. only:: html + + .. image:: /examples/selection/images/thumb/sphx_glr_FeatureSelection-WHODataset_thumb.png + :alt: + + :ref:`getting_started-selection` + +.. raw:: html + +
+

Supervised and unsupervised selection + methods based on + CUR matrix decomposition and Farthest Point Sampling.

+
+
+
+
+
+
+
+ +.. only:: html + + .. image:: /examples/pcovr/images/thumb/sphx_glr_PCovR_thumb.png + :alt: + + :ref:`getting_started-pcovr` + +.. raw:: html + +
+

Utilises a combination between a PCA-like and a LR-like loss + to determine the decomposition matrix to project feature into latent space

+
+
+
+
+
+
+
+ +.. only:: html + + .. image:: /examples/reconstruction/images/thumb/sphx_glr_PlotLFRE_thumb.png + :alt: + + :ref:`getting_started-reconstruction` + +.. raw:: html + +
+

Error measures for quantifying the + linear decodable information capacity between features

+
+
+
+
+
+
.. include:: ../../README.rst :start-after: marker-issues :end-before: marker-contributing