base_logger

Base logger and its helper handlers.

Classes

BaseHandler	Base handler for defining various useful handlers.
BaseLogger	Base logger handler.
BaseOptimizerParamsHandler	Base handler for logging optimizer parameters
BaseOutputHandler	Helper handler to log engine's output and/or metrics
BaseWeightsHandler	Base handler for logging weights or their gradients.
BaseWeightsScalarHandler	Helper handler to log model's weights or gradients as scalars.

class ignite.handlers.base_logger.BaseHandler

Base handler for defining various useful handlers.

class ignite.handlers.base_logger.BaseLogger

Base logger handler. See implementations: TensorboardLogger, VisdomLogger, PolyaxonLogger, MLflowLogger, …

attach(engine, log_handler, event_name, *args, **kwargs)

Attach the logger to the engine and execute log_handler function at event_name events.

Parameters

• engine (Engine) – engine object.

• log_handler (Callable) – a logging handler to execute

• event_name (Union[str, Events, CallableEventWithFilter, EventsList]) – event to attach the logging handler to. Valid events are from Events or EventsList or any event_name added by register_events().

• args (Any) – args forwarded to the log_handler method

• kwargs (Any) – kwargs forwarded to the log_handler method

Returns

RemovableEventHandle, which can be used to remove the handler.

Return type

RemovableEventHandle

attach_opt_params_handler(engine, event_name, *args, **kwargs)

Shortcut method to attach OptimizerParamsHandler to the logger.

Parameters

• engine (Engine) – engine object.

• event_name (Any) – event to attach the logging handler to. Valid events are from Events or any event_name added by register_events().

• args (Any) – args to initialize OptimizerParamsHandler

• kwargs (Any) – kwargs to initialize OptimizerParamsHandler

Returns

RemovableEventHandle, which can be used to remove the handler.

Return type

RemovableEventHandle

Changed in version 0.4.3: Added missing return statement.

attach_output_handler(engine, event_name, *args, **kwargs)

Shortcut method to attach OutputHandler to the logger.

Parameters

• engine (Engine) – engine object.

• event_name (Any) – event to attach the logging handler to. Valid events are from Events or any event_name added by register_events().

• args (Any) – args to initialize OutputHandler

• kwargs (Any) – kwargs to initialize OutputHandler

Returns

RemovableEventHandle, which can be used to remove the handler.

Return type

RemovableEventHandle

class ignite.handlers.base_logger.BaseOptimizerParamsHandler(optimizer, param_name='lr', tag=None)

Base handler for logging optimizer parameters

Parameters

• optimizer (Optimizer) –

• param_name (str) –

• tag (Optional[str]) –

class ignite.handlers.base_logger.BaseOutputHandler(tag, metric_names=None, output_transform=None, global_step_transform=None, state_attributes=None)

Helper handler to log engine’s output and/or metrics

Parameters

• tag (str) –

• metric_names (Optional[Union[str, List[str]]]) –

• output_transform (Optional[Callable]) –

• global_step_transform (Optional[Callable[[Engine, Union[str, Events]], int]]) –

• state_attributes (Optional[List[str]]) –

class ignite.handlers.base_logger.BaseWeightsHandler(model, tag=None, whitelist=None)

Base handler for logging weights or their gradients.

Parameters

• model (Module) –

• tag (Optional[str]) –

• whitelist (Optional[Union[List[str], Callable[[str, Parameter], bool]]]) –

class ignite.handlers.base_logger.BaseWeightsScalarHandler(model, reduction=<function norm>, tag=None, whitelist=None)

Helper handler to log model’s weights or gradients as scalars.

Parameters

• model (Module) –

• reduction (Callable[[Tensor], Union[float, Tensor]]) –

• tag (Optional[str]) –

• whitelist (Optional[Union[List[str], Callable[[str, Parameter], bool]]]) –