Refactor API: ComposerRequirements and ComposerBuilder #852

gkirgizov · 2022-08-30T16:41:12Z

Reorganize ComposerRequirements & GraphOptimiserParameters to be more intuitive and logical.

Main changes

Composer requirements now contain infrastructural (algorithm-independent, like stop condition, performance etc) and graph-composing options
GPGraphOptimiserParameters now contain only evolutionary-operator-related options
Updated tests & examples that used ComposerBuilder
Set with_history in ComposerBuilder by default
Move some implicit evolutionary parameters from operators to GPGraphOptimzierParameters

So, all in all, I hope, it's now a bit more straightforward to define parameters in fedot. Mainly users should look for PipelineComposerRequirements & ComposerBuilder methods.

codecov · 2022-08-30T16:53:06Z

Codecov Report

Merging #852 (44bc34e) into master (3db5464) will increase coverage by 0.24%.
The diff coverage is 95.51%.

@@            Coverage Diff             @@
##           master     #852      +/-   ##
==========================================
+ Coverage   87.72%   87.97%   +0.24%     
==========================================
  Files         195      196       +1     
  Lines       13356    13345      -11     
==========================================
+ Hits        11717    11740      +23     
+ Misses       1639     1605      -34

Impacted Files	Coverage Δ
fedot/api/api_utils/params.py	`92.00% <ø> (ø)`
fedot/core/composer/gp_composer/gp_composer.py	`95.12% <ø> (ø)`
.../core/optimisers/gp_comp/parameters/graph_depth.py	`77.27% <50.00%> (-13.64%)`	⬇️
...ore/optimisers/gp_comp/operators/regularization.py	`55.81% <70.00%> (-2.33%)`	⬇️
fedot/api/api_utils/metrics.py	`83.33% <85.71%> (+3.33%)`	⬆️
...dot/core/optimisers/gp_comp/operators/crossover.py	`90.58% <85.71%> (-1.55%)`	⬇️
fedot/core/optimisers/gp_comp/operators/elitism.py	`96.66% <87.50%> (-0.56%)`	⬇️
...t/core/optimisers/gp_comp/operators/inheritance.py	`96.29% <88.88%> (-3.71%)`	⬇️
...timisers/gp_comp/pipeline_composer_requirements.py	`94.44% <92.85%> (-5.56%)`	⬇️
...edot/core/optimisers/gp_comp/operators/operator.py	`90.90% <93.75%> (+0.90%)`	⬆️
... and 33 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

pep8speaks · 2022-09-05T08:08:29Z

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

In the file fedot/core/optimisers/gp_comp/operators/elitism.py:

Line 2:1: F401 'typing.TYPE_CHECKING' imported but unused

In the file test/unit/optimizer/test_elitism_operator.py:

Line 1:1: F401 'typing.TYPE_CHECKING' imported but unused

Comment last updated at 2022-09-13 08:15:25 UTC

fedot/core/composer/composer_builder.py

fedot/core/optimisers/gp_comp/parameters/graph_depth.py

nicl-nno · 2022-09-05T08:14:37Z

fedot/core/optimisers/gp_comp/pipeline_composer_requirements.py

@@ -15,35 +18,43 @@ class MutationStrengthEnum(Enum):

 @dataclass
 class PipelineComposerRequirements(ComposerRequirements):
-    """
-    Dataclass is for defining the requirements for composition process of genetic programming composer
+    """Defines algorithm-specific parameters of evolutionary optimizer.


algorithm-specific parameters

Не очень понятно, про какой алгоритм речь.

подредактировал f0f8467

"Parameters of evolutionary optimizer that define features of the evolutionary algorithm
and restrictions on the graph composition process"

Я думаю тут стоит сформулировать отличия PipelineComposerRequirements от OptimiserRequirements, чтобы не было путаницы. Даже если сейчас не будет полностью разделять - стоит пояснить, почему это вообще два разных класса.

nicl-nno · 2022-09-05T08:16:05Z

fedot/core/optimisers/gp_comp/pipeline_composer_requirements.py

    :param crossover_prob: crossover probability (the chance that two chromosomes exchange some of their parts)
    :param mutation_prob: mutation probability
    :param mutation_strength: strength of mutation in tree (using in certain mutation types)
-    :param max_pipeline_fit_time: time constraint for operation fitting (minutes)
-    :param start_depth: start value of tree depth
-    :param validation_blocks: number of validation blocks for time series validation
-    :param n_jobs: num of n_jobs
-    :param show_progress: bool indicating whether to show progress using tqdm or not
-    :param collect_intermediate_metric: save metrics for intermediate (non-root) nodes in pipeline
-    :param keep_n_best: Number of the best individuals of previous generation to keep in next generation.
+
+    Population and graph parameters, possibly adaptive:
+    :param offspring_rate: offspring rate used on next population
+    :param pop_size: initial population size; if unspecified, default value is used
+    :param max_pop_size: maximum population size; optional, if unspecified, then population size is unbound


А должны ли ту быть специфичные именно для эволюции штуки? Предполагал что в req к композеру будет как раз-то, что от оптимизатора не зависит (max_depth, например)

Ты про crossover_prob, mutation_prob, mutation_strength ? Согласен, тоже хотел их перенести в GraphOptimizerParameters, но наткнулся на то, что придется побольше кода менять -- тк в процессе эволюции именно requirements адаптивно модифицируются. Это чисто техническая проблемка -- подумаю еще, как это получше организовать. В этом PR не хотелось много времени на это тратить. Тут более простая реорганизация, которая особых изменений в коде оптимизатора не потребовала. Предлагаю это в другом PR устроить, тут уже хватает изменений.

И в целом различие между композером и оптимизтором особо не определено. Все параметры так или иначе параметры оптимизатора. Тут скорее различие в том, что какие-то относятся именно к эволюционному алогритму, а какие-то -- к графовым характеристикам. Если концептуальное различие между оптимизатором и композером именно в этом -- тогда понимаю.

fedot/core/optimisers/optimizer.py

fedot/api/api_utils/api_composer.py

n_jobs, start_depth, show_progress: PipelineComposerRequirements -> ComposerRequirements duplicated max_pipeline_fit_time: drop from pipeline_composer_requirements.py

…rams Move most of GraphOptimizerParams into ComposerRequirements. Make the former a dataclass

with_auto_depth_configuration -> adaptive_depth depth_increase_step -> adaptive_depth_max_stagnation

gkirgizov added refactoring api Anything related to user-facing interfaces & parameter passing labels Aug 30, 2022

gkirgizov requested a review from nicl-nno August 30, 2022 16:41

aPovidlo self-requested a review August 31, 2022 08:05

gkirgizov mentioned this pull request Sep 1, 2022

Release 0.6.0 #755

Closed

aPovidlo approved these changes Sep 1, 2022

View reviewed changes

gkirgizov force-pushed the api-refacs branch from 11be5d6 to a20e97d Compare September 5, 2022 08:08

nicl-nno reviewed Sep 5, 2022

View reviewed changes

fedot/core/composer/composer_builder.py Outdated Show resolved Hide resolved

nicl-nno reviewed Sep 5, 2022

View reviewed changes

fedot/core/optimisers/gp_comp/parameters/graph_depth.py Outdated Show resolved Hide resolved

nicl-nno reviewed Sep 5, 2022

View reviewed changes

fedot/core/optimisers/optimizer.py Outdated Show resolved Hide resolved

nicl-nno reviewed Sep 5, 2022

View reviewed changes

fedot/api/api_utils/api_composer.py Outdated Show resolved Hide resolved

gkirgizov force-pushed the api-refacs branch 6 times, most recently from e9e0519 to 45664fa Compare September 12, 2022 12:19

gkirgizov requested a review from nicl-nno September 12, 2022 12:21

nicl-nno approved these changes Sep 12, 2022

View reviewed changes

gkirgizov added 7 commits September 12, 2022 18:35

minor refactorings 1

2a2d0e7

Simplify handling of init_cache in ApiComposer

321cd78

Better logging string for best models in archive (add metric names)

7cd4f68

Reorganize parameters:

ad56c3e

n_jobs, start_depth, show_progress: PipelineComposerRequirements -> ComposerRequirements duplicated max_pipeline_fit_time: drop from pipeline_composer_requirements.py

Reorganize parameters between ComposerRequirements & GraphOptimizerPa…

f91782a

…rams Move most of GraphOptimizerParams into ComposerRequirements. Make the former a dataclass

Rename with_auto_depth_configuration -> adaptive_depth

251f5d2

Renames:

2699898

with_auto_depth_configuration -> adaptive_depth depth_increase_step -> adaptive_depth_max_stagnation

gkirgizov added 18 commits September 12, 2022 18:35

minor comment changes

6f0b0a5

fix docstrings & move primary/secondary

cf4709d

WIP move optimizer-related params to GrpahOptimizerParameters

8f40da5

WIP

5a7d13d

Make hyperparameters static dict

462e549

Fix update of requirements & gp parameters in evo operators

f5f79c8

fix n_jobs in obj eval

af0fc64

Move self.log to Operator base

44537af

Move geneti parameters to GPGraphOptimizerParameters

3f2fd32

Minor rearranges

a881def

Fix tests & examples due to parameter rearrangement

0bcf889

Remove build of GraphOptimizerParameters from composer_builder.py

a9ea232

Fix incorrectly passed optimizer params in parameter_change_mutation

6c638b4

Rebase fixes

82eafd3

pep8 import fixes

687f778

pep8 import fixes

8972ee7

fix GraphOptimizerParameters import

4d317d5

Fix elisitm operator with incorrent sorting direction

d014ba6

gkirgizov force-pushed the api-refacs branch from 8b33ed4 to d014ba6 Compare September 12, 2022 15:36

gkirgizov added 2 commits September 12, 2022 19:00

Revert elitism fix

00b37db

Set with_history in ComposerBuilder by default

ffe0e68

gkirgizov force-pushed the api-refacs branch 4 times, most recently from 6f64e54 to 6b5798e Compare September 13, 2022 07:43

gkirgizov mentioned this pull request Jan 25, 2023

Implement API Parameter Facade aimclub/GOLEM#23

Closed

Move additional params from mutation operator to GraphOptParams

44bc34e

gkirgizov force-pushed the api-refacs branch from 6b5798e to 44bc34e Compare September 13, 2022 08:15

gkirgizov merged commit fd2daed into master Sep 13, 2022

gkirgizov deleted the api-refacs branch September 13, 2022 08:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor API: ComposerRequirements and ComposerBuilder #852

Refactor API: ComposerRequirements and ComposerBuilder #852

gkirgizov commented Aug 30, 2022 •

edited

Loading

codecov bot commented Aug 30, 2022 •

edited

Loading

pep8speaks commented Sep 5, 2022 •

edited

Loading

nicl-nno Sep 5, 2022

gkirgizov Sep 5, 2022

nicl-nno Sep 5, 2022

nicl-nno Sep 5, 2022

gkirgizov Sep 5, 2022

Refactor API: ComposerRequirements and ComposerBuilder #852

Refactor API: ComposerRequirements and ComposerBuilder #852

Conversation

gkirgizov commented Aug 30, 2022 • edited Loading

codecov bot commented Aug 30, 2022 • edited Loading

Codecov Report

pep8speaks commented Sep 5, 2022 • edited Loading

Comment last updated at 2022-09-13 08:15:25 UTC

nicl-nno Sep 5, 2022

Choose a reason for hiding this comment

gkirgizov Sep 5, 2022

Choose a reason for hiding this comment

nicl-nno Sep 5, 2022

Choose a reason for hiding this comment

nicl-nno Sep 5, 2022

Choose a reason for hiding this comment

gkirgizov Sep 5, 2022

Choose a reason for hiding this comment

gkirgizov commented Aug 30, 2022 •

edited

Loading

codecov bot commented Aug 30, 2022 •

edited

Loading

pep8speaks commented Sep 5, 2022 •

edited

Loading