docs: update each module documentation

src/cognitivefactory/interactive_clustering/__init__.py

@@ -6,8 +6,14 @@
 * Author:       Erwan SCHILD
 * Created:      17/03/2021
 * Licence:      CeCILL (https://cecill.info/licences.fr.html)
+
+Three modules are available:
+- `constraints`: it provides a constraints manager, that stores annotated constraints on data and gives some feedback on information deduced (such as the transitivity between constraints or the situation of inconsistency). See [interactive_clustering/constraints](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/constraints/) documentation ;
+- `sampling`: it provides several constraints sampling algorithm, that selecte relevant contraints to annotate by an expert. See [interactive_clustering/sampling](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/sampling/) documentation ;
+- `clustering`: it provides several constrained clustering algorithms, that partition the data according to annotated constraints. See [interactive_clustering/clustering](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/) documentation ;
+- `utils`: it provides several basic functionnalities, like data preprocessing and data vectorization. See [interactive_clustering/utils](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/utils/) documentation.
 """
 
 from typing import List
 
-__all__: List[str] = []  # noqa: WPS410 (only __variable__ we use)
+__all__: List[str] = []  # noqa: WPS410 (only __variable__ we use)

src/cognitivefactory/interactive_clustering/clustering/__init__.py

@@ -6,4 +6,14 @@
 * Author:       Erwan SCHILD
 * Created:      17/03/2021
 * Licence:      CeCILL-C License v1.0 (https://cecill.info/licences.fr.html)
-"""
+
+This module provides several constrained clustering algorithms, that partition the data according to annotated constraints :
+- `abstract`: an abstract class that defines constrained clustering algorithms functionnalities. See [interactive_clustering/clustering/abstract](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/abstract/) documentation ;
+- `factory`: a factory to easily instantiate constrained clustering algorithm object. See [interactive_clustering/clustering/factory](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/factory/) documentation ;
+- `kmeans`: a constrained clustering algorithm implementation that uses COP-KMeans. See [interactive_clustering/clustering/kmeans](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/kmeans/) documentation ;
+- `hierarchical`: a constrained clustering algorithm implementation that uses constrained hierarchical clustering. See [interactive_clustering/clustering/hierarchical](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/hierarchical/) documentation ;
+- `spectral`: a constrained clustering algorithm implementation that uses constrained spectral clustering. See [interactive_clustering/clustering/spectral](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/spectral/) documentation ;
+- `affinity_propagation`: a constrained clustering algorithm implementation that uses constrained affinity propagation clustering (_not production ready !_). See [interactive_clustering/clustering/affinity_propagation](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/affinity_propagation/) documentation ;
+- `dbscan`: a constrained clustering algorithm implementation that uses C-DBScan (_not production ready !_). See [interactive_clustering/clustering/dbscan](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/dbscan/) documentation ;
+- `mpckmeans`: a constrained clustering algorithm implementation that uses MPC-KMeans (_not production ready !_). See [interactive_clustering/clustering/mpckmeans](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/clustering/mpckmeans/) documentation.
+"""

src/cognitivefactory/interactive_clustering/constraints/__init__.py

@@ -6,4 +6,9 @@
 * Author:       Erwan SCHILD
 * Created:      17/03/2021
 * Licence:      CeCILL-C License v1.0 (https://cecill.info/licences.fr.html)
-"""
+
+This module provides a constraints manager, that stores annotated constraints on data and gives some feedback on information deduced (such as the transitivity between constraints or the situation of inconsistency) :
+- `abstract`: an abstract class that defines constraints managers functionnalities. See [interactive_clustering/constraints/abstract](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/constraints/abstract/) documentation ;
+- `factory`: a factory to easily instantiate constraints manager object. See [interactive_clustering/constraints/factory](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/constraints/factory/) documentation ;
+- `binary`: a constraints manager implementation that handles `MUST-LINK` and `CANNOT-LINK` constraints on pairs of data. See [interactive_clustering/constraints/binary](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/constraints/binary/) documentation ;
+"""

src/cognitivefactory/interactive_clustering/sampling/__init__.py

@@ -6,4 +6,9 @@
 * Author:       Erwan SCHILD
 * Created:      17/03/2021
 * Licence:      CeCILL (https://cecill.info/licences.fr.html)
-"""
+
+This module provides several constraints sampling algorithm, that selecte relevant contraints to annotate by an expert :
+- `abstract`: an abstract class that defines constraints sampling algorithms functionnalities. See [interactive_clustering/sampling/abstract](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/sampling/abstract/) documentation ;
+- `factory`: a factory to easily instantiate constraints sampling algorithm object. See [interactive_clustering/sampling/factory](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/sampling/factory/) documentation ;
+- `clusters_based`: a constraints sampling algorithm implementation that uses constraints annotation, data similarity and clustering results. See [interactive_clustering/sampling/clusters_based](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/sampling/clusters_based/) documentation ;
+"""

src/cognitivefactory/interactive_clustering/utils/__init__.py

@@ -6,4 +6,8 @@
 * Author:       Erwan SCHILD
 * Created:      17/03/2021
 * Licence:      CeCILL (https://cecill.info/licences.fr.html)
-"""
+
+This module provides several basic functionnalities, like data preprocessing and data vectorization :
+- `preprocessing`: a method to preprocess data. See [interactive_clustering/utils/preprocessing](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/utils/preprocessing/) documentation.
+- `vectorization`: a method to vectoize data. See [interactive_clustering/utils/vectorization](https://cognitivefactory.github.io/interactive-clustering/reference/cognitivefactory/interactive_clustering/utils/vectorization/) documentation.
+"""