TorchLiter

module torchliter.engine.events

Global Variables

• REPR_INDENT

---

class EventCategory

An enumeration.

---

class EventHandler

Base Class for Event Handlers.

method EventHandler.__init__

__init__(
    action_function: Optional[Callable[[torchliter.engine.base.EngineBase], NoneType]] = None,
    trigger_function: Optional[Callable[[torchliter.engine.base.EngineBase], bool]] = None,
    **kwargs
)

---

method EventHandler.action

action(*args, **kwargs)

---

classmethod EventHandler.config

config(*args, **kwargs) → Type

Add additional config kwargs.

For example ====================

@EventHandler.config(param1=1.0, param2=2.0) def some_action_function(engine): …

---

method EventHandler.trigger

trigger(engine: torchliter.engine.base.EngineBase) → bool

---

class PreEpochHandler

Hanldes events when a new epoch starts.

method PreEpochHandler.__init__

__init__(
    action_function: Callable[[torchliter.engine.base.EngineBase], NoneType],
    trigger_function: Optional[Callable[[torchliter.engine.base.EngineBase], bool]] = None,
    every: int = 1,
    train_stub: bool = True,
    eval_stub: bool = True,
    lambda_stub: bool = False
)

---

method PreEpochHandler.action

action(*args, **kwargs)

---

classmethod PreEpochHandler.config

config(*args, **kwargs) → Type

Add additional config kwargs.

For example ====================

@EventHandler.config(param1=1.0, param2=2.0) def some_action_function(engine): …

---

method PreEpochHandler.trigger

trigger(engine: torchliter.engine.base.EngineBase) → bool

---

class PostEpochHandler

Hanldes events when a new epoch finishes.

method PostEpochHandler.__init__

__init__(
    action_function: Callable[[torchliter.engine.base.EngineBase], NoneType],
    trigger_function: Optional[Callable[[torchliter.engine.base.EngineBase], bool]] = None,
    every: int = 1,
    train_stub: bool = True,
    eval_stub: bool = True,
    lambda_stub: bool = False
)

---

method PostEpochHandler.action

action(*args, **kwargs)

---

classmethod PostEpochHandler.config

config(*args, **kwargs) → Type

Add additional config kwargs.

For example ====================

@EventHandler.config(param1=1.0, param2=2.0) def some_action_function(engine): …

---

method PostEpochHandler.trigger

trigger(engine: torchliter.engine.base.EngineBase) → bool

---

class PreIterationHandler

Handles events before each iteration.

method PreIterationHandler.__init__

__init__(
    action_function: Callable[[torchliter.engine.base.EngineBase], NoneType],
    trigger_function: Optional[Callable[[torchliter.engine.base.EngineBase], bool]] = None,
    every: int = 1,
    train_stub: bool = True,
    eval_stub: bool = True,
    lambda_stub: bool = False
)

---

method PreIterationHandler.action

action(*args, **kwargs)

---

classmethod PreIterationHandler.config

config(*args, **kwargs) → Type

Add additional config kwargs.

For example ====================

@EventHandler.config(param1=1.0, param2=2.0) def some_action_function(engine): …

---

method PreIterationHandler.trigger

trigger(engine: torchliter.engine.base.EngineBase) → bool

---

class PostIterationHandler

Handles events after each iteration.

method PostIterationHandler.__init__

__init__(
    action_function: Callable[[torchliter.engine.base.EngineBase], NoneType],
    trigger_function: Optional[Callable[[torchliter.engine.base.EngineBase], bool]] = None,
    every: int = 1,
    train_stub: bool = True,
    eval_stub: bool = True,
    lambda_stub: bool = False
)

---

method PostIterationHandler.action

action(*args, **kwargs)

---

classmethod PostIterationHandler.config

config(*args, **kwargs) → Type

Add additional config kwargs.

For example ====================

@EventHandler.config(param1=1.0, param2=2.0) def some_action_function(engine): …

---

method PostIterationHandler.trigger

trigger(engine: torchliter.engine.base.EngineBase) → bool

---

class Engine

Engine with Event Handler plugin.

Attributes ———- _event_handlers : Dict[EventCategory, List[EventHandler]] The registry of event handlers.

method Engine.__init__

__init__()

---

property Engine.absolute_iterations

---

property Engine.fractional_epoch

---

property Engine.fractional_iteration

---

property Engine.is_eval_stub

---

property Engine.is_lambda_stub

---

property Engine.is_train_stub

---

property Engine.training

---

method Engine.after_iteration

after_iteration()

---

method Engine.attach_event

attach_event(handler: torchliter.engine.events.EventHandler)

Attach an event handler.

Parameters ———- handler : EventHandler An event handler to be attached.

---

method Engine.before_iteration

before_iteration()

---

method Engine.list_events

list_events(
    event_category: Optional[str] = None
) → Tuple[torchliter.engine.events.EventHandler]

List events based on category.

Parameters ———- event_category : Optional[str] List event handlers in event_category (the default is None). If not provided, list all handlers.

Returns ——- Tuple[EventHandler] Tuple of handlers.

---

method Engine.when_epoch_finishes

when_epoch_finishes()

---

method Engine.when_epoch_starts

when_epoch_starts()

This site is open source. Improve this page.