Function build_optimizer

modelscope/trainers/optimizer/builder.py:13–38

build optimizer from optimizer config dict Args: model: A torch.nn.Module or an iterable of parameters. cfg (:obj:`ConfigDict`): config dict for optimizer object. default_args (dict, optional): Default initialization arguments.

(model: Union[torch.nn.Module,
                                 Iterable[torch.nn.parameter.Parameter]],
                    cfg: ConfigDict,
                    default_args: dict = None)

def build_optimizer(model: Union[torch.nn.Module,
                                 Iterable[torch.nn.parameter.Parameter]],
                    cfg: ConfigDict,
                    default_args: dict = None):
    """ build optimizer from optimizer config dict

    Args:
        model: A torch.nn.Module or an iterable of parameters.
        cfg (:obj:`ConfigDict`): config dict for optimizer object.
        default_args (dict, optional): Default initialization arguments.
    """
    if default_args is None:
        default_args = {}

    if isinstance(model, torch.nn.Module) or (hasattr(
            model, 'module') and isinstance(model.module, torch.nn.Module)):
        if hasattr(model, 'module'):
            model = model.module

        default_args['params'] = model.parameters()
    else:
        # Input is a iterable of parameters, this case fits for the scenario of user-defined parameter groups.
        default_args['params'] = model

    return build_from_cfg(
        cfg, OPTIMIZERS, group_key=default_group, default_args=default_args)


def register_torch_optimizers():