mmengine.runner.get_state_dict

mmengine.runner.get_state_dict(module, destination=None, prefix='', keep_vars=False)

Returns a dictionary containing a whole state of the module.

Both parameters and persistent buffers (e.g. running averages) are included. Keys are corresponding parameter and buffer names. This method is modified from torch.nn.Module.state_dict() to recursively check parallel module in case that the model has a complicated structure, e.g., nn.Module(nn.Module(DDP)).

Parameters

• module (nn.Module) – The module to generate state_dict.

• destination (OrderedDict) – Returned dict for the state of the module.

• prefix (str) – Prefix of the key.

• keep_vars (bool) – Whether to keep the variable property of the parameters. Default: False.

Returns

A dictionary containing a whole state of the module.

Return type

dict