From 345ff5cd54085b4601cf2921a1e29878360841c3 Mon Sep 17 00:00:00 2001 From: Pakulin Sergei Date: Tue, 4 Apr 2023 15:22:16 +0300 Subject: [PATCH] PR fixes (v1) --- docs/source/basics/concepts.rst | 2 +- .../fedot_features/automation/data_nature.rst | 6 ++++-- .../automation/dimensionality_reduction.rst | 19 ++++++++++++++----- .../fedot_features/automation/learning.rst | 4 ++-- .../fedot_features/automation/models_used.rst | 14 ++++++++++++++ .../fedot_features/automation/used_models.rst | 11 ----------- .../introduction/fedot_features/tasks.rst | 5 +---- .../introduction/tutorial/quickstart.rst | 3 +-- docs/source/introduction/what_is_fedot.rst | 2 +- 9 files changed, 38 insertions(+), 28 deletions(-) create mode 100644 docs/source/introduction/fedot_features/automation/models_used.rst delete mode 100644 docs/source/introduction/fedot_features/automation/used_models.rst diff --git a/docs/source/basics/concepts.rst b/docs/source/basics/concepts.rst index 814660a7fd..427e7e1192 100644 --- a/docs/source/basics/concepts.rst +++ b/docs/source/basics/concepts.rst @@ -1,7 +1,7 @@ Main Concepts ============= -The main concepts of the framework are the follows: +The main framework concepts are as follows:: - **Flexibility.** FEDOT can be used to automate the construction of solutions for various problems, data types (texts, images, tables), and models; - **Integrability.** FEDOT supports widely used ML libraries (Scikit-learn, CatBoost, XGBoost, etc.) and allows you to integrate custom ones; diff --git a/docs/source/introduction/fedot_features/automation/data_nature.rst b/docs/source/introduction/fedot_features/automation/data_nature.rst index 6b10032641..b705cc22af 100644 --- a/docs/source/introduction/fedot_features/automation/data_nature.rst +++ b/docs/source/introduction/fedot_features/automation/data_nature.rst @@ -4,8 +4,10 @@ Data nature FEDOT uses specific data processing according to the source of the input data (whether it is pandas DataFrame, or numpy array, or just a path to the dataset, etc). -.. - Стоит ли тут написать, что datetime будет конвертиться в число? +.. note:: + + Be careful with datetime features, as they are to be casted into a float type with milliseconds unit. + Apart from that FEDOT is capable of working with multi-modal data. It means that you can pass it different types of datasets diff --git a/docs/source/introduction/fedot_features/automation/dimensionality_reduction.rst b/docs/source/introduction/fedot_features/automation/dimensionality_reduction.rst index 3b1a5601f1..d91de61309 100644 --- a/docs/source/introduction/fedot_features/automation/dimensionality_reduction.rst +++ b/docs/source/introduction/fedot_features/automation/dimensionality_reduction.rst @@ -1,7 +1,16 @@ -Dimensionality reduction ------------------------- +Dimensionality operations +------------------------- -Currently FEDOT supports only feature selection algorithms provided by scikit-learn, but there aren't extraction ones. +FEDOT supports bunch of dimension preprocessing operations that can be be added to the pipeline as a node. -.. - [А что по ITMO_FS у нас, кстати? Вроде нигде не используется на 28.03.2023] +Feature selection +^^^^^^^^^^^^^^^^^ + +There are different linear and non-linear algorithms for regression and classification tasks +which uses scikit-learn's Recursive Feature Elimination (RFE). + +Feature extraction +^^^^^^^^^^^^^^^^^^ + +Currently there are PCA (kernel methods supported), fast ICA and +polynomial features algorithms for generating new features. \ No newline at end of file diff --git a/docs/source/introduction/fedot_features/automation/learning.rst b/docs/source/introduction/fedot_features/automation/learning.rst index 76f4d995bf..b8b2cc733c 100644 --- a/docs/source/introduction/fedot_features/automation/learning.rst +++ b/docs/source/introduction/fedot_features/automation/learning.rst @@ -4,7 +4,7 @@ Learning FEDOT is capable of setting its 'automation rate' by omitting some of its parameters. For example, if you just create the FEDOT instance and call the ``fit`` method with the appropriate dataset on it, you will have a full automation of the learning process, -see :doc:`automated composing <../../tutorial/composing_pipelines/automated_creation>` +see :doc:`automated composing ` At the same time, if you pass some of the parameters, you will have a partial automation, -see :doc:`manual composing <../../tutorial/composing_pipelines/manual_creation>` \ No newline at end of file +see :doc:`manual composing ` \ No newline at end of file diff --git a/docs/source/introduction/fedot_features/automation/models_used.rst b/docs/source/introduction/fedot_features/automation/models_used.rst new file mode 100644 index 0000000000..72d363a53e --- /dev/null +++ b/docs/source/introduction/fedot_features/automation/models_used.rst @@ -0,0 +1,14 @@ +Models used +----------- + +Using the parameter ``preset`` of the :doc:`main API ` you can specify +what models are available during the learning process. + +It influences: + +* composing speed and quality +* computational behaviour +* task relevance + +.. note:: + To make it simple, FEDOT uses ``auto`` by default to identify the best choice for you. \ No newline at end of file diff --git a/docs/source/introduction/fedot_features/automation/used_models.rst b/docs/source/introduction/fedot_features/automation/used_models.rst deleted file mode 100644 index 9619e39e53..0000000000 --- a/docs/source/introduction/fedot_features/automation/used_models.rst +++ /dev/null @@ -1,11 +0,0 @@ -Used models ------------ - -Using ``preset`` :doc:`main API parameter ` you can specify -what models are available during the learning process. - -That option thereby influences: - -* composing speed -* it's computational behaviour (CPU or GPU models) -* reasonability of the selected models according to the task field. \ No newline at end of file diff --git a/docs/source/introduction/fedot_features/tasks.rst b/docs/source/introduction/fedot_features/tasks.rst index 85bb2596cf..5a5cefeb4f 100644 --- a/docs/source/introduction/fedot_features/tasks.rst +++ b/docs/source/introduction/fedot_features/tasks.rst @@ -5,7 +5,4 @@ FEDOT is currently capable of solving: * Classification * Regression -* Clustering (but not as the main one yet) -* Time-series problems ([uni/multi]variate) - -The last is not true to many other frameworks and also that versatility is not true either. \ No newline at end of file +* Time-series forecasting ([uni/multi]variate) \ No newline at end of file diff --git a/docs/source/introduction/tutorial/quickstart.rst b/docs/source/introduction/tutorial/quickstart.rst index 38c42c5579..bcd3aa219c 100644 --- a/docs/source/introduction/tutorial/quickstart.rst +++ b/docs/source/introduction/tutorial/quickstart.rst @@ -3,8 +3,7 @@ Quick start FEDOT Framework quick start guide. -It does not matter which operating system you use. FEDOT works perfectly on either Windows, or macOS, -or Linux distributions. +Fedot has been perfectly supported on Windows, Linux, and MacOS systems. Firstly, you need to setup the environment to work with the relevant libs. Secondly, you must learn, how to build your solutions: you can do it both manually and automatically. diff --git a/docs/source/introduction/what_is_fedot.rst b/docs/source/introduction/what_is_fedot.rst index 5821705f0e..2c6d62d5b7 100644 --- a/docs/source/introduction/what_is_fedot.rst +++ b/docs/source/introduction/what_is_fedot.rst @@ -27,7 +27,7 @@ FEDOT supports a full life-сyсle of machine learning task that includes prepro prediction = model.predict(features=x_test) metrics = model.get_metrics(target=y_test) -Once FEDOT finds the best solution you have an opportunity :doc:`to save it <../basics/pipeline_save_load>` and look closer to the solution and optimization process if needed. +Once FEDOT finds the best solution you have an opportunity :doc:`to save it ` and look closer to the solution and optimization process if needed. |Example of solution|