docs: update __init__.py documentation

cognitivefactory · Nov 16, 2023 · 063bf92 · 063bf92
1 parent a11d153
commit 063bf92
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/cognitivefactory/features_maximization_metric/__init__.py b/src/cognitivefactory/features_maximization_metric/__init__.py
@@ -1,7 +1,14 @@
+# -*- coding: utf-8 -*-
+
 """
-cognitivefactory-features-maximization-metric package.
+* Name:         cognitivefactory.features_maximization_metric
+* Description:  Implementation of Features Maximization Metric, an unbiased metric aimed at estimate the quality of an unsupervised classification.
+* Author:       Erwan SCHILD
+* Created:      16/02/2023
+* Licence:      CeCILL (https://cecill.info/licences.fr.html)
 
-Implementation of Features Maximization Metric, an unbiased metric aimed at estimate the quality of an unsupervised classification.
+One module is available:
+- `fmc`: the implementation of Features Maximization Metric. See [features_maximization_metric/utils](https://cognitivefactory.github.io/features-maximization-metric/reference/cognitivefactory/features_maximization_metric/fmc/) documentation.
 """
 
 from typing import List