global_step_from_engine

ignite.handlers.global_step_from_engine(engine, custom_event_name=None, fallback_attr='epoch')

Helper method to setup global_step_transform function using another engine. This can be helpful for logging trainer epoch/iteration while output handler is attached to an evaluator.

If the provided event is not registered in State.event_to_attr, the function falls back to using engine.state.<fallback_attr>.

Parameters:

• engine (Engine) – engine which state is used to provide the global step

• custom_event_name (Events | None) – registered event name. Optional argument, event name to use.

• fallback_attr (str) – State attribute used when event is not registered. Default, “epoch”.

Returns:

Callable returning global step value.

Return type:

Callable

Changed in version 0.5.4: added fallback_attr argument as fallback State attribute.