ModelSummary

class lightning.pytorch.callbacks.ModelSummary(max_depth=1, **summarize_kwargs)

Bases: Callback

Generates a summary of all layers in a LightningModule.

Parameters:

• max_depth (int) – The maximum depth of layer nesting that the summary will include. A value of 0 turns the layer summary off.

• **summarize_kwargs (Any) – Additional arguments to pass to the summarize method.

Example:

>>> from lightning.pytorch import Trainer
>>> from lightning.pytorch.callbacks import ModelSummary
>>> trainer = Trainer(callbacks=[ModelSummary(max_depth=1)])

on_fit_start(trainer, pl_module)

Called when fit begins.

Return type:

None