split_yaml ¶

def get_args() -> argparse.Namespace:
    """Get the arguments when using from the command line."""
    parser = argparse.ArgumentParser(description="")
    parser.add_argument(
        "-j",
        "--yaml",
        type=str,
        required=True,
        metavar="FILE",
        help="The YAML config file that hold all transform - split - parameter info",
    )
    parser.add_argument(
        "-d",
        "--out_dir",
        type=str,
        required=False,
        nargs="?",
        const="./",
        default="./",
        metavar="DIR",
        help="The output dir where all the YAMLs are written to. Output YAML will be called split-#[number].yaml transform-#[number].yaml. Default -> ./",
    )

    return parser.parse_args()

def main(config_yaml: str, out_dir_path: str) -> None:
    """Reads a YAML config file and generates all possible data configurations.

    This script reads a YAML with a defined structure and creates all the YAML files ready to be passed to
    the stimulus package.

    The structure of the YAML is described here -> TODO paste here link to documentation.
    This YAML and it's structure summarize how to generate all the transform - split and respective parameter combinations.
    Each resulting YAML will hold only one combination of the above three things.

    This script will always generate at least one YAML file that represent the combination that does not touch the data (no transform)
    and uses the default split behavior.
    """
    # read the yaml experiment config and load it to dictionary
    yaml_config: dict[str, Any] = {}
    with open(config_yaml) as conf_file:
        yaml_config = yaml.safe_load(conf_file)

    yaml_config_dict: YamlConfigDict = YamlConfigDict(**yaml_config)
    # check if the yaml schema is correct
    check_yaml_schema(yaml_config_dict)

    # generate all the YAML configs
    data_configs = generate_data_configs(yaml_config_dict)

    # dump all the YAML configs into files
    dump_yaml_list_into_files(data_configs, out_dir_path, "test")