The watcher.api.controllers.v1.efficacy_indicator Module¶

An efficacy indicator is a single value that gives an indication on how the solution produced by a given strategy performed. These efficacy indicators are specific to a given goal and are usually used to compute the global efficacy of the resulting action plan.

In Watcher, these efficacy indicators are specified alongside the goal they relate to. When a strategy (which always relates to a goal) is executed, it produces a solution containing the efficacy indicators specified by the goal. This solution, which has been translated by the Watcher Planner into an action plan, will see its indicators and global efficacy stored and would now be accessible through the Watcher API.

class watcher.api.controllers.v1.efficacy_indicator.EfficacyIndicator(**kwargs)[source]¶

Bases: watcher.api.controllers.base.APIBase

API representation of a efficacy indicator.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an efficacy indicator.