Function named_parameters

axlearn/experiments/test_utils.py:44–79

Obtains the named parameters for golden config test. Args: module: A module. match_by_name: A string which will be used for selecting config_names for golden config. attr_name: The attribute name to get the named configs from module. data_dir: The data_dir to set

(
    module: ModuleType,
    *,
    match_by_name: Optional[str] = None,
    attr_name: str = "named_trainer_configs",
    data_dir: str = "$DATA_DIR",
)

def named_parameters(
    module: ModuleType,
    *,
    match_by_name: Optional[str] = None,
    attr_name: str = "named_trainer_configs",
    data_dir: str = "$DATA_DIR",
) -> list[tuple[str, ModuleType, str, TrainerConfigFn]]:
    """Obtains the named parameters for golden config test.

    Args:
        module: A module.
        match_by_name: A string which will be used for selecting config_names for golden config.
        attr_name: The attribute name to get the named configs from module.
        data_dir: The data_dir to set when fetching the configs.

    Returns:
        A list of
        - a string with {module}.{name}
        - a ModuleType module
        - a config name
        - the trainer config for the module.config_name.
    """
    with set_data_dir(data_dir):
        final_named_trainer_configs = {}
        named_trainer_configs = getattr(module, attr_name)()
        if match_by_name:
            # If match_by_name is not None, filter config_names based on match_by_name.
            for name in named_trainer_configs.keys():
                if re.fullmatch(match_by_name, name):
                    final_named_trainer_configs[name] = named_trainer_configs[name]
        else:
            final_named_trainer_configs = named_trainer_configs
        return [
            (f"{module.__name__}.{name}", module, name, final_named_trainer_configs[name])
            for name in final_named_trainer_configs.keys()
        ]


def param_init_debug_string(