timeeval.integration package

Available integration modules:

Base class for TimeEval modules

class timeeval.integration.TimeEvalModule

Bases: ABC

Base class for TimeEval modules that add additional functionality to TimeEval.

Inheriting classes can implement any of the following lifecycle-hooks:

  1. prepare()

  2. pre_run()

  3. post_run()

  4. finalize()

These methods are called at the corresponding time in the TimeEval run loop. Modules can assume that the TimeEval configuration is already loaded and checked for user errors. If TimeEval is executed in distributed mode, timeeval.TimeEval.distributed is set to True and remoting is already set up before the first call to prepare().

Note

Implementing a TimeEval module is an advanced usage scenario and requires a good understanding of the internals of TimeEval.

finalize(timeeval: TimeEval) → None

Called during the FINALIZE-phase of TimeEval and after the individual algorithms’ finalize-functions were executed.

Parameters

timeeval (TimeEval) – The TimeEval instance that is currently running.

post_run(timeeval: TimeEval) → None

Called after the EVALUATION-phase of TimeEval.

Parameters

timeeval (TimeEval) – The TimeEval instance that is currently running.

pre_run(timeeval: TimeEval) → None

Called before the EVALUATION-phase of TimeEval.

Parameters

timeeval (TimeEval) – The TimeEval instance that is currently running.

prepare(timeeval: TimeEval) → None

Called during the PREPARE-phase of TimeEval and before the individual algorithms’ prepare-functions are executed.

Parameters

timeeval (TimeEval) – The TimeEval instance that is currently running.