Events

frogbox.engines.events

Event

Event(event, every=None, first=None, last=None)

Bases: MatchableEvent

Event.

EventList

EventList()

Bases: MatchableEvent

List of events.

EventStep

Bases: str, Enum

Engine event step.

Attributes:

• STARTED (str) –

  Engine run started.

• EPOCH_STARTED (str) –

  Epoch started.

• ITERATION_STARTED (str) –

  Iteration started.

• ITERATION_COMPLETED (str) –

  Iteration completed.

• EPOCH_COMPLETED (str) –

  Epoch completed.

• COMPLETED (str) –

  Engine run completed.

MatchableEvent

Bases: ABC

Base class for events that can be matched against.

matches abstractmethod

matches(event, step)

Check if event matches specific event step iteration.