Add documented API params setters #1077

MorrisNein · 2023-03-31T18:48:56Z

Change list:

Create FedotBuilder class used for constructing Fedot instances.
Add usage examples
Add tests
Write documentation

Motivation:

make API parameters easier to document for us (actual documented function arguments with type hints instead of a plain docstring);
make API parameters easier to understand and set for outer users (code autocompletion, type hints).

Existing documented kwargs are divided in logical blocks, each of them got its separate setter in new FedotBuilder class:

setup_composition
- timeout
- task_params
- seed
- preset
- with_tuning
- use_meta_rules
setup_parallelization
- n_jobs
- parallelization_mode
setup_output
- logging_level
- show_progress
- cache_dir
- history_dir
setup_evolution
- initial_assumption
- num_of_generations
- early_stopping_iterations
- early_stopping_timeout
- pop_size
- keep_n_best
- genetic_scheme
- use_pipelines_cache
- optimizer
setup_pipeline_structure
- available_operations
- max_depth
- max_arity
setup_pipeline_evaluation
- metric
- cv_folds
- max_pipeline_fit_time
- collect_intermediate_metric
setup_data_processing
- safe_mode
- use_input_preprocessing
- use_preprocessing_cache

Usage examples

codecov · 2023-03-31T19:09:46Z

Codecov Report

Attention: Patch coverage is 97.67442% with 1 line in your changes missing coverage. Please review.

Project coverage is 79.55%. Comparing base (a5a9b17) to head (70c0c59).
Report is 63 commits behind head on master.

Files	Patch %	Lines
fedot/api/builder.py	97.50%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1077      +/-   ##
==========================================
+ Coverage   79.54%   79.55%   +0.01%     
==========================================
  Files         142      145       +3     
  Lines        9805     9995     +190     
==========================================
+ Hits         7799     7952     +153     
- Misses       2006     2043      +37

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

gkirgizov

Будет ли пользователю удобно искать, какой параметр к какому блоку относится? Например, мне нужно задать только метрику оптимизации -- как понять, какой with_... написать?

gkirgizov · 2023-04-11T08:12:27Z

fedot/api/main.py

+    def with_composer_params(
+            self, *ignore,
+            show_progress: Optional[bool] = None,
+            preset: Optional[str] = None,
+            with_tuning: Optional[bool] = None,
+            use_meta_rules: Optional[bool] = None,
+            cache_dir: Optional[str] = None,
+            history_dir: Optional[str] = None,
+    ):


Объясни, как эти неиспользуземые аргументы затем попадают дальше в оптимизаторы и тд?

Пока что работаю над этим, чуть поспешили с запросом на ревью. Запрошу повторный ревью, как допилю функционал

Теперь попадают через основной апи)
Сеттеры добавил в отдельную сущность

IIaKyJIuH · 2023-04-11T13:44:12Z

fedot/api/main.py


        safe_mode: if set ``True`` it will cut large datasets to prevent memory overflow and use label encoder
-            instead of oneHot encoder if summary cardinality of categorical features is high.
+            instead of OneHot encoder if summary cardinality of categorical features is high.


One-hot чаще встречается.

Исправил

IIaKyJIuH · 2023-04-11T13:45:38Z

fedot/api/main.py

+        n_jobs: num of ``n_jobs`` for parallelization (set to ``-1`` to use all cpu's). Defaults to ``-1``.
+        parallelization_mode (str): type of evaluation for groups of individuals (``'populational'`` or
+            ``'sequential'``). Default value is ``'populational'``.


Не убрал исходное описание до твоих правок чуть ниже.

Исправлено

IIaKyJIuH · 2023-04-11T13:52:42Z

fedot/api/main.py


        Returns:
-            the array with prediction values
+            The array with prediction values.


По-моему, не очень понятно, что это за конкретное The array, Может показаться, что изменяется входной features, не лучше ли An array, чтобы подчеркнуть, что возвращается "некоторый" массив?

Актуально и для других подобных мест

Везде, где увидел, поправил

IIaKyJIuH · 2023-04-11T14:01:00Z

docs/source/advanced/hyperparameters_tuning.rst

+If ``with_tuning`` flag is set to ``True`` when using :doc:`FEDOT API </api/api>`, simultaneous hyperparameters tuning is applied for composed pipeline and ``metric`` value is used as a metric for tuning.

 Simple example
 ~~~~~~~~~~~~~~


Я понимаю, что это рекомендация, но мб для единообразия попробовать следовать этим принципам?

Если да, то под "=" должен быть "-"

Актуально для других мест тоже.

Это больше не входит в данный PR

docs/source/advanced/sensitivity_analysis.rst

docs/source/api/sensitivity.rst

IIaKyJIuH · 2023-04-11T14:07:34Z

fedot/api/api_utils/assumptions/assumptions_handler.py


-        :param data: data for pipelines
+        Args:
+            data: data for pipelines.


Почему нельзя написать один раз data, а внутренность по контексту будет понятна?

Можно, конечно. Я просто обновил стиль докстринги, содержание не трогал. Поменяю

MorrisNein · 2023-04-12T18:42:10Z

Будет ли пользователю удобно искать, какой параметр к какому блоку относится? Например, мне нужно задать только метрику оптимизации -- как понять, какой with_... написать?

Я надеюсь, что из названия методов должно быть понятно. Например, вызываешь with_... и смотришь контекстные подсказки. Метрика относится к оценке пайплайнов -> наверняка нужно выбрать with_pipeline_evaluation_params.

Ещё можно сделать блоки параметров пересекающимися, если параметры подходят по контексту в несколько групп.

pep8speaks · 2023-09-29T14:41:55Z

Hello @MorrisNein! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file fedot/__init__.py:

Line 3:1: F403 'from fedot import ' used; unable to detect undefined names
Line 3:1: F401 'fedot.' imported but unused
Line 4:1: F401 'fedot.api.Fedot' imported but unused
Line 4:1: F401 'fedot.api.FedotBuilder' imported but unused
Line 5:1: F401 'fedot.version.version' imported but unused

In the file fedot/api/__init__.py:

Line 1:1: F401 'fedot.api.main.Fedot' imported but unused
Line 2:1: F401 'fedot.api.builder.FedotBuilder' imported but unused

Comment last updated at 2023-10-18 06:15:32 UTC

aim-pep8-bot · 2023-09-29T14:41:56Z

Hello @MorrisNein! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2023-09-29 15:36:52 UTC

MorrisNein · 2023-09-29T15:20:56Z

Переделал состав параметров в группах. Насколько удобно получилось -- посмотрите, пожалуйста.

Есть альтернативная идея сделать отдельные сеттеры для каждого из параметров API на этапе установки библиотеки. Наподобие того, как это реализовано в matplotlib.

Что-то вроде FedotBuilder.pop_size(pop_size).

Но эта реализация несколько более муторная, возможно, даже есть смысл посмотреть в сторону программной генерации кода.

gkirgizov · 2023-10-12T14:12:36Z

Что-то вроде FedotBuilder.pop_size(pop_size).

Но эта реализация несколько более муторная, возможно, даже есть смысл посмотреть в сторону программной генерации кода.

Данное решение уже достаточно хорошо. Думаю, пока не возникнут новые неудобства, можно на этом остановиться. Класс

MorrisNein · 2023-10-18T06:18:51Z

Благодаря написанным тестам нашёл пропущенный параметр keep_history. Он был не задокументирован в основном API, и поэтому изначально не попал в FedotBuilder.

Так что буду считать покрытие нового функционала тестами вполне достаточным для начала.

MorrisNein force-pushed the api_params_setters branch 2 times, most recently from 8248538 to a0a553d Compare March 31, 2023 19:03

MorrisNein changed the base branch from master to api_doc March 31, 2023 19:03

nicl-nno requested review from IIaKyJIuH and gkirgizov March 31, 2023 19:58

aimclub locked and limited conversation to collaborators Apr 1, 2023

aimclub unlocked this conversation Apr 1, 2023

MorrisNein force-pushed the api_doc branch 3 times, most recently from 0378d7a to b20d45b Compare April 3, 2023 16:16

Base automatically changed from api_doc to master April 3, 2023 16:24

gkirgizov reviewed Apr 11, 2023

View reviewed changes

IIaKyJIuH requested changes Apr 11, 2023

View reviewed changes

MorrisNein force-pushed the api_params_setters branch from a0a553d to 14386bb Compare April 12, 2023 18:52

MorrisNein marked this pull request as draft June 21, 2023 12:33

MorrisNein force-pushed the api_params_setters branch from 14386bb to cc90eed Compare September 29, 2023 14:41

MorrisNein marked this pull request as ready for review September 29, 2023 15:16

MorrisNein requested review from IIaKyJIuH and gkirgizov September 29, 2023 15:21

MorrisNein force-pushed the api_params_setters branch from aa693f6 to 7e03668 Compare September 29, 2023 15:36

gkirgizov approved these changes Oct 12, 2023

View reviewed changes

IIaKyJIuH approved these changes Oct 13, 2023

View reviewed changes

MorrisNein force-pushed the api_params_setters branch 2 times, most recently from 398c45c to a171c9f Compare October 17, 2023 14:29

MorrisNein force-pushed the api_params_setters branch 2 times, most recently from eda0813 to 8de2cf4 Compare October 17, 2023 14:36

MorrisNein added 7 commits October 17, 2023 19:59

create FedotBuilder

4babfd5

add examples for FedotBuilder

3df60e5

pep8 & comments

045f579

clear main API docstring

9c937dc

allow FedotBuilder to be imported directly from fedot

6a3eaf2

write docstrings

ed21aca

add keep_history param

1a24757

MorrisNein force-pushed the api_params_setters branch 3 times, most recently from 6cd91b5 to 2e79a45 Compare October 17, 2023 21:06

MorrisNein added 2 commits October 18, 2023 01:08

write tests

cc6ea72

add FedotBuilder to the documentation

eb693b1

MorrisNein force-pushed the api_params_setters branch from f2ef5cf to 2294403 Compare October 17, 2023 22:19

MorrisNein added 5 commits October 18, 2023 09:14

add documentation

fa3a8ca

simplify examples

a0131af

fix docstring

058720b

remove unnecessary Optional

e78d6ab

add representation to class DefaultParamValue

70c0c59

MorrisNein force-pushed the api_params_setters branch from 2294403 to 70c0c59 Compare October 18, 2023 06:15

MorrisNein merged commit 9cd08a0 into master Oct 18, 2023

MorrisNein deleted the api_params_setters branch October 18, 2023 06:18

Add documented API params setters #1077

Add documented API params setters #1077

Uh oh!

Conversation

MorrisNein commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gkirgizov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MorrisNein commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pep8speaks commented Sep 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated at 2023-10-18 06:15:32 UTC

Uh oh!

aim-pep8-bot commented Sep 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated at 2023-09-29 15:36:52 UTC

Uh oh!

MorrisNein commented Sep 29, 2023

Uh oh!

gkirgizov commented Oct 12, 2023

Uh oh!

MorrisNein commented Oct 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

MorrisNein commented Mar 31, 2023 •

edited

Loading

codecov bot commented Mar 31, 2023 •

edited

Loading

MorrisNein commented Apr 12, 2023 •

edited

Loading

pep8speaks commented Sep 29, 2023 •

edited

Loading

aim-pep8-bot commented Sep 29, 2023 •

edited

Loading