pyrevs.strategies.base

Submodules

• pyrevs.strategies.base.strategy
• pyrevs.strategies.base.termination

Classes

BaseSamplingStrategy	An interface for all rare-event algorithms.
LowScoreTerminationCriterion	Termination criterion based on score.
TerminationCriterion	Termination criterion interface.
TimeTerminationCriterion	Termination criterion based on time.

Package Contents

class BaseSamplingStrategy

Bases: abc.ABC

An interface for all rare-event algorithms.

Define the common interface for sampling strategies within the sampler object.

A registry is used to store all available strategies. It is managed using a decorator and entry_points.

Subclasses must implement the following methods: - sample() - out_of_time()

classmethod register(name: str) → collections.abc.Callable[[type[T]], type[T]]

Register a new strategy.

Parameters:

name – the strategy name

classmethod create(name: str, *args: Any, **kwargs: Any) → BaseSamplingStrategy

Instantiate a strategy out of the registry.

Parameters:

• name – the strategy name

• *args – positional arguments

• **kwargs – keyword arguments

classmethod available_strategies() → list[str]

Return list of registered strategy names.

sample(database: pyrevs.database.Database, walltime: float, plot_diags: bool) → None

Run the sampling lifecycle.

This method handles walltime bookkeeping and delegates the algorithm implementation to _execute_sampling.

Subclasses must implement _execute_sampling and should regularly check out_of_time() to terminate gracefully.

Parameters:

• database – Database used for storing results.

• walltime – Maximum allowed runtime in seconds.

• plot_diags – Whether to enable diagnostic plotting.

remaining_time() → float

Return the remaining wallclock time.

out_of_time() → bool

Return true if insufficient walltime remains.

elapsed_time() → float

Return the elapsed wallclock time.

abstractmethod initialize_database_schema(database: pyrevs.database.Database, diag_configs: dict[str, pyrevs.core.Config] | None) → None

Initialize the schema of the database.

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 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.