sunpeek.core_methods.common.main.CoreStrategy#

class sunpeek.core_methods.common.main.CoreStrategy(component)#

Bases: ABC

Strategy of some CoreAlgorithm. To be attached to an algorithm with algo.define_strategies().

A strategy is defined for a specific component and should implement methods _calc() and _get_feedback().

Methods

__init__(component)

check_output(output)

Additional checks to be performed on output of a strategy.

execute()

Try to calculate strategy, sanitize check output dict and return if ok.

get_feedback(check_mode)

check_output(output)#

Additional checks to be performed on output of a strategy.

execute()#

Try to calculate strategy, sanitize check output dict and return if ok.

Returns:

  • elapsed_time (float, elapsed time in algorithm in seconds)

  • output (dict, strategy output, values are asserted to be unit-aware (pint-pandas) Series.)

Raises:

AlgorithmError