pyrevs.strategies.base.termination

Defines the interface and simple implementations of termination criteria.

Attributes

T_Noise
T_State

Classes

TerminationCriterion	Termination criterion interface.
TimeTerminationCriterion	Termination criterion based on time.
LowScoreTerminationCriterion	Termination criterion based on score.
ModelTerminationCriterion	Termination criterion based on model.

Module Contents

T_Noise

T_State

class TerminationCriterion

Bases: Protocol

Termination criterion interface.

abstractmethod should_terminate(model: pyrevs.core.ForwardModelBaseClass[T_Noise, T_State], trajectory: pyrevs.trajectory.Trajectory) → bool

Check if the trajectory should terminate.

Parameters:

• model – the forward model

• trajectory – the trajectory

Returns:

True if the trajectory should terminate

class TimeTerminationCriterion(end_time: float)

Bases: TerminationCriterion

Termination criterion based on time.

Will trigger termination if the current time is greater than or equal to the end time.

should_terminate(model: pyrevs.core.ForwardModelBaseClass[T_Noise, T_State], trajectory: pyrevs.trajectory.Trajectory) → bool

Check if the trajectory should terminate.

class LowScoreTerminationCriterion(score_threshold: float)

Bases: TerminationCriterion

Termination criterion based on score.

Will trigger termination if the current score is less than or equal to a threshold.

should_terminate(model: pyrevs.core.ForwardModelBaseClass[T_Noise, T_State], trajectory: pyrevs.trajectory.Trajectory) → bool

Check if the trajectory should terminate.

class ModelTerminationCriterion

Bases: TerminationCriterion

Termination criterion based on model.

Will trigger termination if the forward model has decides to.

should_terminate(model: pyrevs.core.ForwardModelBaseClass[T_Noise, T_State], trajectory: pyrevs.trajectory.Trajectory) → bool

Check if the trajectory should terminate.