docs: minor update in documentation

cognitivefactory · Nov 17, 2023 · 33ead8e · 33ead8e
1 parent 064ea61
commit 33ead8e
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 7 deletions.
diff --git a/src/cognitivefactory/interactive_clustering_gui/__init__.py b/src/cognitivefactory/interactive_clustering_gui/__init__.py
@@ -1,7 +1,18 @@
+# -*- coding: utf-8 -*-
+
 """
-Interactive Clustering GUI package.
+* Name:         cognitivefactory.interactive_clustering_gui
+* Description:  Web application for Interactive Clustering methodology.
+* Author:       Erwan SCHILD
+* Created:      22/10/2021
+* Licence:      CeCILL (https://cecill.info/licences.fr.html)
+
+Several modules and files are needed for this web application:
 
-Web application for Interactive Clustering methodology
+- `app`: the main application file, that defines FastAPI routes (project management, ). See [interactive_clustering_gui/app](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/app/) documentation ;
+- `backgroundtasks`: the worker file, that defines tasks to run in background (). See [interactive_clustering_gui/backgroundtasks](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/backgroundtasks/) documentation ;
+- `models`: the models file, that defines requests parameters and application states. See [interactive_clustering_gui/models](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/models/) documentation ;
+- `cli`: the command line input functionnalities, needed to launch the app. See [interactive_clustering_gui/cli](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/cli/) documentation.
 """
 
 from typing import List

diff --git a/src/cognitivefactory/interactive_clustering_gui/models/__init__.py b/src/cognitivefactory/interactive_clustering_gui/models/__init__.py
@@ -1,5 +1,15 @@
+# -*- coding: utf-8 -*-
+
 """
-Interactive Clustering GUI package.
+* Name:         cognitivefactory.interactive_clustering_gui
+* Description:  Web application for Interactive Clustering methodology.
+* Author:       Erwan SCHILD
+* Created:      22/10/2021
+* Licence:      CeCILL (https://cecill.info/licences.fr.html)
+
+The models file, that defines requests parameters and application states:
 
-Web application for Interactive Clustering methodology
+- `app`: it defines query parameters models required for application requests. See [interactive_clustering_gui/models/queries](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/models/queries/) documentation ;
+- `settings`: it defines algorithm settings models required for application runs. See [interactive_clustering_gui/models/settings](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/models/settings/) documentation ;
+- `states`: it defins states models required for application runs. See [interactive_clustering_gui/models/states](https://cognitivefactory.github.io/interactive-clustering-gui/reference/cognitivefactory/interactive_clustering_gui/models/states/) documentation ;
 """
diff --git a/src/cognitivefactory/interactive_clustering_gui/models/queries.py b/src/cognitivefactory/interactive_clustering_gui/models/queries.py
@@ -2,7 +2,7 @@
 
 """
 * Name:         cognitivefactory.interactive_clustering_gui.models.queries
-* Description:  Definition of model parameters required to define query parameters of interactive clustering.
+* Description:  Definition of query parameters models required for application requests.
 * Author:       Erwan Schild
 * Created:      07/02/2022
 * Licence:      CeCILL-C License v1.0 (https://cecill.info/licences.fr.html)

diff --git a/src/cognitivefactory/interactive_clustering_gui/models/settings.py b/src/cognitivefactory/interactive_clustering_gui/models/settings.py
@@ -2,7 +2,7 @@
 
 """
 * Name:         cognitivefactory.interactive_clustering_gui.models.settings
-* Description:  Definition of model parameters required to define settings of interactive clustering.
+* Description:  Definition of algorithm settings models required for application runs.
 * Author:       Erwan Schild
 * Created:      16/12/2021
 * Licence:      CeCILL-C License v1.0 (https://cecill.info/licences.fr.html)

diff --git a/src/cognitivefactory/interactive_clustering_gui/models/states.py b/src/cognitivefactory/interactive_clustering_gui/models/states.py
@@ -2,7 +2,7 @@
 
 """
 * Name:         cognitivefactory.interactive_clustering_gui.models.states
-* Description:  Definition of models required to define states of interactive clustering.
+* Description:  Definition of states models required for application runs.
 * Author:       Erwan Schild
 * Created:      25/04/2022
 * Licence:      CeCILL-C License v1.0 (https://cecill.info/licences.fr.html)