Skip to content

utils

configs_from_arg_combinations(args, arg_list)

Generates a list of configurations from a list of arguments. Each configuration is one of a cartesian product of the arguments provided and identified in arg_list.

Parameters:

Name Type Description Default
args Namespace

The arguments.

 required
arg_list list[str]

The list of arguments to generate configurations from.

 required

Returns:

Type Description
list[dict[str, Any]]

A list of configurations.
Source code in src/nhssynth/modules/model/utils.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def configs_from_arg_combinations(args: argparse.Namespace, arg_list: list[str]) -> list[dict[str, Any]]:
    """
    Generates a list of configurations from a list of arguments. Each configuration is one of a cartesian product of
    the arguments provided and identified in `arg_list`.

    Args:
        args: The arguments.
        arg_list: The list of arguments to generate configurations from.

    Returns:
        A list of configurations.
    """
    wrapped_args = {arg: wrap_arg(getattr(args, arg)) for arg in arg_list}
    combinations = list(itertools.product(*wrapped_args.values()))
    return [{k: v for k, v in zip(wrapped_args.keys(), values) if v is not None} for values in combinations]

get_experiments(args)

Generates a dataframe of experiments from the arguments provided.

Parameters:

Name Type Description Default
args Namespace

The arguments.

 required

Returns:

Type Description
DataFrame

A dataframe of experiments indexed by architecture, repeat and config ID.
Source code in src/nhssynth/modules/model/utils.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def get_experiments(args: argparse.Namespace) -> pd.DataFrame:
    """
    Generates a dataframe of experiments from the arguments provided.

    Args:
        args: The arguments.

    Returns:
        A dataframe of experiments indexed by architecture, repeat and config ID.
    """
    experiments = pd.DataFrame(
        columns=["architecture", "repeat", "config", "model_config", "seed", "train_config", "num_configs"]
    )
    train_configs = configs_from_arg_combinations(args, ["num_epochs", "patience"])
    for arch_name, repeat in itertools.product(*[wrap_arg(args.architecture), list(range(args.repeats))]):
        arch = MODELS[arch_name]
        model_configs = configs_from_arg_combinations(args, arch.get_args() + ["batch_size", "use_gpu"])
        for i, (train_config, model_config) in enumerate(itertools.product(train_configs, model_configs)):
            experiments.loc[len(experiments.index)] = {
                "architecture": arch_name,
                "repeat": repeat + 1,
                "config": i + 1,
                "model_config": model_config,
                "num_configs": len(model_configs) * len(train_configs),
                "seed": args.seed + repeat if args.seed else None,
                "train_config": train_config,
            }
    return experiments.set_index(["architecture", "repeat", "config"], drop=True)

wrap_arg(arg)

Wraps a single argument in a list if it is not already a list or tuple.

Parameters:

Name Type Description Default
arg Any

The argument to wrap.

 required

Returns:

Type Description
Union[list, tuple]

The wrapped argument.
Source code in src/nhssynth/modules/model/utils.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
def wrap_arg(arg: Any) -> Union[list, tuple]:
    """
    Wraps a single argument in a list if it is not already a list or tuple.

    Args:
        arg: The argument to wrap.

    Returns:
        The wrapped argument.
    """
    if not isinstance(arg, list) and not isinstance(arg, tuple):
        return [arg]
    return arg