Doc params tuning (#916)

* WIP hyperparams tuning * Add hyperparameters tuning doc * Minor fixes * Minor fixes 2) * Minor fixes 3 * Polish docs, Fix time constraint for fit * Minor fix * Refine hyperparameters_tuning.rst * Fix classification_pipelines.rst * Fix classification_pipelines.rst * Fix classification_pipelines.rst * Remove classification_pipelines.rst * Correct examples names * Add classification_pipelines.rst * Change paths to images * Add regression_pipelines.rst and ts_pipelines.rst * Minor fix
aimclub · Oct 4, 2022 · 55e6528 · 55e6528
1 parent d3aca03
commit 55e6528
Show file tree

Hide file tree

Showing 43 changed files with 602 additions and 94 deletions.
diff --git a/docs/source/advanced/hyperparameters_tuning.rst b/docs/source/advanced/hyperparameters_tuning.rst
diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -2,7 +2,8 @@ FEDOT API
 =========
 
 .. autoclass:: fedot.api.main.Fedot
+
    :members:
    :no-undoc-members:
    :no-private-members:
-   :no-special-members:
+   :no-special-members:
diff --git a/docs/source/basics/index.rst b/docs/source/basics/index.rst
@@ -8,3 +8,4 @@ Basics
    tabular_data
    ts_forecasting
    multi_modal_tasks
+   data_preprocessing
diff --git a/docs/source/examples/classification_pipelines.rst b/docs/source/examples/classification_pipelines.rst
@@ -0,0 +1,6 @@
+Classification pipelines
+========================
+
+.. automodule:: examples.simple.classification.classification_pipelines
+   :members:
+   :no-undoc-members:
diff --git a/docs/source/examples/img_classification_pipelines/class_with_balancing.png b/docs/source/examples/img_classification_pipelines/class_with_balancing.png
diff --git a/docs/source/examples/img_classification_pipelines/class_without_balancing.png b/docs/source/examples/img_classification_pipelines/class_without_balancing.png
diff --git a/docs/source/examples/img_classification_pipelines/cnn_composite_pipeline.png b/docs/source/examples/img_classification_pipelines/cnn_composite_pipeline.png
diff --git a/docs/source/examples/img_classification_pipelines/complex_pipeline.png b/docs/source/examples/img_classification_pipelines/complex_pipeline.png
diff --git a/docs/source/examples/img_classification_pipelines/complex_rf_pipeline.png b/docs/source/examples/img_classification_pipelines/complex_rf_pipeline.png
diff --git a/docs/source/examples/img_classification_pipelines/isolation_forest.png b/docs/source/examples/img_classification_pipelines/isolation_forest.png
diff --git a/docs/source/examples/img_classification_pipelines/manual_three_depth_pipeline.png b/docs/source/examples/img_classification_pipelines/manual_three_depth_pipeline.png
diff --git a/docs/source/examples/img_classification_pipelines/random_forest.png b/docs/source/examples/img_classification_pipelines/random_forest.png
diff --git a/docs/source/examples/img_classification_pipelines/svc_complex_pipeline.png b/docs/source/examples/img_classification_pipelines/svc_complex_pipeline.png
diff --git a/docs/source/examples/img_regression_pipelines/ransac.png b/docs/source/examples/img_regression_pipelines/ransac.png
diff --git a/docs/source/examples/img_regression_pipelines/three_depth_manual.png b/docs/source/examples/img_regression_pipelines/three_depth_manual.png
diff --git a/docs/source/examples/img_ts_pipelines/clstm_pipeline.png b/docs/source/examples/img_ts_pipelines/clstm_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_ar_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_ar_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_arima_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_arima_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_complex_dtreg_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_complex_dtreg_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_complex_ridge_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_complex_ridge_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_complex_ridge_smoothing_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_complex_ridge_smoothing_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_ets_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_ets_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_ets_ridge_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_ets_ridge_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_glm_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_glm_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_glm_ridge_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_glm_ridge_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_locf_ridge_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_locf_ridge_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_multiple_ets_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_multiple_ets_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_naive_average_ridge_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_naive_average_ridge_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_polyfit_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_polyfit_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_polyfit_ridge_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_polyfit_ridge_pipeline.png
diff --git a/docs/source/examples/img_ts_pipelines/ts_stl_arima_pipeline.png b/docs/source/examples/img_ts_pipelines/ts_stl_arima_pipeline.png
diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
@@ -4,3 +4,7 @@ Examples and notebooks
 .. toctree::
    :glob:
    :maxdepth: 1
+
+   classification_pipelines
+   regression_pipelines
+   ts_pipelines
diff --git a/docs/source/examples/regression_pipelines.rst b/docs/source/examples/regression_pipelines.rst
@@ -0,0 +1,6 @@
+Regression pipelines
+====================
+
+.. automodule:: examples.simple.regression.regression_pipelines
+   :members:
+   :no-undoc-members:
diff --git a/docs/source/examples/ts_pipelines.rst b/docs/source/examples/ts_pipelines.rst
@@ -0,0 +1,6 @@
+Time series forecasting pipelines
+=================================
+
+.. automodule:: examples.simple.time_series_forecasting.ts_pipelines
+   :members:
+   :no-undoc-members:
diff --git a/examples/simple/classification/classification_pipelines.py b/examples/simple/classification/classification_pipelines.py
@@ -6,9 +6,8 @@ def cnn_composite_pipeline(composite_flag: bool = True) -> Pipeline:
     """
     Returns pipeline with the following structure:
 
-    cnn \
-          -> rf -> [rf] -> final prediction
-    cnn /
+    .. image:: img_classification_pipelines/cnn_composite_pipeline.png
+      :width: 55%
 
     Where cnn - convolutional neural network, rf - random forest
 
@@ -35,7 +34,8 @@ def classification_pipeline_with_balancing(custom_params=None):
     """
     Returns pipeline with the following structure:
 
-    resample -> logit -> final prediction
+    .. image:: img_classification_pipelines/class_with_balancing.png
+      :width: 55%
 
     Where resample - algorithm for balancing dataset, logit - logistic_regression
 
@@ -53,11 +53,12 @@ def classification_pipeline_with_balancing(custom_params=None):
 
 def classification_pipeline_without_balancing():
     """
-    Returns pipeline with the following structure:
+    Returns: pipeline with the following structure:
 
-    logit -> final prediction
+    .. image:: img_classification_pipelines/class_without_balancing.png
+      :width: 55%
 
-    Where resample - algorithm for balancing dataset, logit - logistic_regression
+    Where logit - logistic_regression
     """
     node = PrimaryNode(operation_type='logit')
 
@@ -68,9 +69,9 @@ def classification_complex_pipeline():
     """
     Returns pipeline with the following structure:
 
-    rf  \
-         -> logit -> final prediction
-    knn /
+    .. image:: img_classification_pipelines/complex_pipeline.png
+      :width: 55%
+
     """
     first = PrimaryNode(operation_type='rf')
     second = PrimaryNode(operation_type='knn')
@@ -86,7 +87,9 @@ def classification_random_forest_pipeline():
     """
     Returns pipeline with the following structure:
 
-    scaling -> rf -> final prediction
+    .. |random_forest| image:: img_classification_pipelines/random_forest.png
+      :width: 55%
+
     """
     node_scaling = PrimaryNode('scaling')
     node_final = SecondaryNode('rf', nodes_from=[node_scaling])
@@ -96,7 +99,10 @@ def classification_random_forest_pipeline():
 def classification_isolation_forest_pipeline():
     """
     Returns pipeline with the following structure:
-    scaling -> isolation_forest -> rf -> final prediction
+
+    .. |isolation_forest| image:: img_classification_pipelines/isolation_forest.png
+      :width: 55%
+
     """
     node_first = PrimaryNode('scaling')
     node_second = SecondaryNode('isolation_forest_class', nodes_from=[node_first])
@@ -108,15 +114,12 @@ def classification_svc_complex_pipeline():
     """
     Returns pipeline with the following structure:
 
-    svc -> logit \
-                  \
-                    rf -> final prediction
-        knn -> knn /
-                  /
-    svc -> logit /
+    .. image:: img_classification_pipelines/svc_complex_pipeline.png
+      :width: 55%
 
     Where svc - support vector classifier, logit - logistic regression, knn - K nearest neighbors classifier,
-     rf - random forest classifier
+    rf - random forest classifier
+
     """
 
     svc_primary_node = PrimaryNode('svc')
@@ -143,10 +146,8 @@ def classification_three_depth_manual_pipeline():
     """
     Returns pipeline with the following structure:
 
-    logit \
-           knn \
-      rf /     knn -> final prediction
-    rf -> qda /
+    .. image:: img_classification_pipelines/manual_three_depth_pipeline.png
+      :width: 55%
 
     Where rf - xg boost classifier, logit - logistic regression, knn - K nearest neighbors classifier,
     qda - discriminant analysis
@@ -169,14 +170,8 @@ def classification_rf_complex_pipeline():
     """
     Returns pipeline with the following structure:
 
-        logit \
-              rf \
-         lda /         \
-                       rf -> final prediction
-        logit -> knn /
-                   /
-              lda /
-
+    .. image:: img_classification_pipelines/complex_rf_pipeline.png
+      :width: 55%
 
     Where lda - discriminant analysis, logit - logistic regression, rf - random forest classifier,
     knn - K nearest neighbors classifier

diff --git a/examples/simple/regression/regression_pipelines.py b/examples/simple/regression/regression_pipelines.py
@@ -6,9 +6,8 @@ def regression_three_depth_manual_pipeline():
     """
     Returns pipeline with the following structure:
 
-          rfr -> dtreg  \
-                         knnreg - > final prediction
-          knnreg -> rfr /
+    .. image:: img_regression_pipelines/three_depth_manual.png
+      :width: 55%
 
     Where rf - random forest, dtreg - tree regression, knn - K nearest neighbors regression,
    """
@@ -29,7 +28,8 @@ def regression_ransac_pipeline():
     """
     Returns pipeline with the following structure:
 
-          scaling -> ransac_lin_reg -> lasso -> final prediction
+    .. image:: img_regression_pipelines/ransac.png
+      :width: 55%
 
     Where ransac_lin_reg - ransac algorithm
    """