fastreid.utils.checkpoint Namespace Reference

Classes
class	Checkpointer
class	PeriodicCheckpointer

Functions
	get_missing_parameters_message (list keys)
	get_unexpected_parameters_message (list keys)
	_strip_prefix_if_present (collections.OrderedDict state_dict, str prefix)
	_group_checkpoint_keys (list keys)
	_group_to_str (list group)

Function Documentation

_group_checkpoint_keys()

fastreid.utils.checkpoint._group_checkpoint_keys ( list keys )

protected

Group keys based on common prefixes. A prefix is the string up to the final
"." in each key.
Args:
    keys (list[str]): list of parameter names, i.e. keys in the model
        checkpoint dict.
Returns:
    dict[list]: keys with common prefixes are grouped into lists.

Definition at line 369 of file checkpoint.py.

def _group_checkpoint_keys(keys: list):
    """
    Group keys based on common prefixes. A prefix is the string up to the final
    "." in each key.
    Args:
        keys (list[str]): list of parameter names, i.e. keys in the model
            checkpoint dict.
    Returns:
        dict[list]: keys with common prefixes are grouped into lists.
    """
    groups = defaultdict(list)
    for key in keys:
        pos = key.rfind(".")
        if pos >= 0:
            head, tail = key[:pos], [key[pos + 1:]]
        else:
            head, tail = key, []
        groups[head].extend(tail)
    return groups
 
 

_group_to_str()

fastreid.utils.checkpoint._group_to_str ( list group )

protected

Format a group of parameter name suffixes into a loggable string.
Args:
    group (list[str]): list of parameter name suffixes.
Returns:
    str: formated string.

Definition at line 390 of file checkpoint.py.

def _group_to_str(group: list):
    """
    Format a group of parameter name suffixes into a loggable string.
    Args:
        group (list[str]): list of parameter name suffixes.
    Returns:
        str: formated string.
    """
    if len(group) == 0:
        return ""
 
    if len(group) == 1:
        return "." + group[0]
 
    return ".{" + ", ".join(group) + "}"

_strip_prefix_if_present()

fastreid.utils.checkpoint._strip_prefix_if_present ( collections.OrderedDict state_dict, str prefix )

protected

Strip the prefix in metadata, if any.
Args:
    state_dict (OrderedDict): a state-dict to be loaded to the model.
    prefix (str): prefix.

Definition at line 336 of file checkpoint.py.

def _strip_prefix_if_present(state_dict: collections.OrderedDict, prefix: str):
    """
    Strip the prefix in metadata, if any.
    Args:
        state_dict (OrderedDict): a state-dict to be loaded to the model.
        prefix (str): prefix.
    """
    keys = sorted(state_dict.keys())
    if not all(len(key) == 0 or key.startswith(prefix) for key in keys):
        return
 
    for key in keys:
        newkey = key[len(prefix):]
        state_dict[newkey] = state_dict.pop(key)
 
    # also strip the prefix in metadata, if any..
    try:
        metadata = state_dict._metadata
    except AttributeError:
        pass
    else:
        for key in list(metadata.keys()):
            # for the metadata dict, the key can be:
            # '': for the DDP module, which we want to remove.
            # 'module': for the actual model.
            # 'module.xx.xx': for the rest.
 
            if len(key) == 0:
                continue
            newkey = key[len(prefix):]
            metadata[newkey] = metadata.pop(key)
 
 

get_missing_parameters_message()

fastreid.utils.checkpoint.get_missing_parameters_message

(

list

keys

)

Get a logging-friendly message to report parameter names (keys) that are in
the model but not found in a checkpoint.
Args:
    keys (list[str]): List of keys that were not found in the checkpoint.
Returns:
    str: message.

Definition at line 301 of file checkpoint.py.

def get_missing_parameters_message(keys: list):
    """
    Get a logging-friendly message to report parameter names (keys) that are in
    the model but not found in a checkpoint.
    Args:
        keys (list[str]): List of keys that were not found in the checkpoint.
    Returns:
        str: message.
    """
    groups = _group_checkpoint_keys(keys)
    msg = "Some model parameters are not in the checkpoint:\n"
    msg += "\n".join(
        "  " + colored(k + _group_to_str(v), "blue") for k, v in groups.items()
    )
    return msg
 
 

get_unexpected_parameters_message()

fastreid.utils.checkpoint.get_unexpected_parameters_message

(

list

keys

)

Get a logging-friendly message to report parameter names (keys) that are in
the checkpoint but not found in the model.
Args:
    keys (list[str]): List of keys that were not found in the model.
Returns:
    str: message.

Definition at line 318 of file checkpoint.py.

def get_unexpected_parameters_message(keys: list):
    """
    Get a logging-friendly message to report parameter names (keys) that are in
    the checkpoint but not found in the model.
    Args:
        keys (list[str]): List of keys that were not found in the model.
    Returns:
        str: message.
    """
    groups = _group_checkpoint_keys(keys)
    msg = "The checkpoint contains parameters not used by the model:\n"
    msg += "\n".join(
        "  " + colored(k + _group_to_str(v), "magenta")
        for k, v in groups.items()
    )
    return msg