Skip to content

confextractionmetafunction

confextractionmetafunction

modules for configinfoextractor

Classes

ConfigInfoExtractor 

ConfigInfoExtractor(
    name,
    info_path,
    info_format_func=None,
    use_yaml_files=False,
)

Bases: MetaFunction

Extracts information from ExperimentData

Source code in niceml/experiments/confextractionmetafunction.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
def __init__(
    self,
    name: str,
    info_path: Union[List[Union[str, int]], List[List[Union[str, int]]]],
    info_format_func: Optional[Callable] = None,
    use_yaml_files: bool = False,
):
    self.name = name
    self.info_path_list: List[List[Union[str, int]]] = (
        info_path if isinstance(info_path[0], list) else [info_path]
    )
    self.info_format_func = info_format_func
    self.use_yaml_files = use_yaml_files

DictKeysToStringFormatFunc 

DictKeysToStringFormatFunc(key_list, join_str='x')

Extracts the given key list from the dictionary

Source code in niceml/experiments/confextractionmetafunction.py 
49
50
51
def __init__(self, key_list: List[str], join_str: str = "x"):
    self.key_list = key_list
    self.join_str = join_str

Functions

git_hashtag_shortener 

git_hashtag_shortener(hashtag)

Return a 6-digit hashtag

Source code in niceml/experiments/confextractionmetafunction.py 
65
66
67
68
69
70
71
def git_hashtag_shortener(hashtag: Union[str, bytes, None]):
    """Return a 6-digit hashtag"""
    if hashtag is None:
        return None
    if isinstance(hashtag, bytes):
        hashtag = hashtag.decode("utf-8")
    return hashtag[:6]

hydra_instance_format 

hydra_instance_format(input_data)

Selects between target (dict) and origignal str

Source code in niceml/experiments/confextractionmetafunction.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def hydra_instance_format(input_data: Union[str, dict]) -> str:
    """Selects between _target_ (dict) and origignal str"""
    if isinstance(input_data, dict):
        if "_target_" not in input_data:
            raise KeyError(f"Key _target_ not in input: {input_data}")
        info: str = input_data["_target_"]
        info = rsplit_format_func(info) + "("
        args = [
            f"{cur_arg}={input_data[cur_arg]}"
            for cur_arg in input_data
            if cur_arg != "_target_"
        ]
        info += ",".join(args) + ")"

    elif isinstance(input_data, str):
        info = input_data
    else:
        info = str(input_data)
    return info

list_to_str_format_func 

list_to_str_format_func(input_list)

Concatenates a list of str joined with a comma

Source code in niceml/experiments/confextractionmetafunction.py 
74
75
76
77
78
79
80
81
82
def list_to_str_format_func(input_list: Union[list, str, None]) -> Optional[str]:
    """Concatenates a list of str joined with a comma"""
    if input_list is None:
        return None
    if isinstance(input_list, str):
        return input_list
    str_list = [str(x) for x in input_list]
    out_str = ",".join(str_list)
    return out_str

list_type_format_func 

list_type_format_func(input_list)

Select from every list entry the target component

Source code in niceml/experiments/confextractionmetafunction.py 
129
130
131
132
133
134
def list_type_format_func(input_list: List[dict]):
    """Select from every list entry the _target_ component"""
    out_list = []
    for cur_type in input_list:
        out_list.append(str_or_type_format_func(cur_type))
    return out_list

rsplit_format_func 

rsplit_format_func(input_str)

Returns the last part after the dot

Source code in niceml/experiments/confextractionmetafunction.py 
120
121
122
123
124
125
126
def rsplit_format_func(input_str: str) -> str:
    """Returns the last part after the dot"""
    if "." not in input_str:
        return input_str
    if input_str.endswith("."):
        input_str = input_str[:-1]
    return input_str.rsplit(".", maxsplit=1)[1]

str_or_type_format_func 

str_or_type_format_func(input)

Selects between target (dict) and origignal str

Source code in niceml/experiments/confextractionmetafunction.py 
85
86
87
88
89
90
91
92
93
94
95
96
def str_or_type_format_func(input: Union[str, dict]) -> str:
    """Selects between _target_ (dict) and origignal str"""
    if isinstance(input, dict):
        if "_target_" not in input:
            raise KeyError(f"Key _target_ not in input: {input}")
        info: str = input["_target_"]
        info = rsplit_format_func(info)
    elif isinstance(input, str):
        info = input
    else:
        info = str(input)
    return info