Skip to content

experimentcontext

experimentcontext

Module for the ExperimentContext

Classes

ExperimentContext dataclass

ExperimentContext to provide the ids and storage

Functions
create_folder 
create_folder(folder)

Creates a folder relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
144
145
146
147
148
149
def create_folder(self, folder: str):
    """Creates a folder relative to the experiment"""
    file_system: AbstractFileSystem
    with open_location(self.fs_config) as (file_system, root_path):
        abs_folder = join(root_path, folder)
        file_system.makedirs(abs_folder, exist_ok=True)
instantiate_datadescription_from_yaml 
instantiate_datadescription_from_yaml()

Instantiates a DataDescription from a yaml file

Source code in niceml/experiments/experimentcontext.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
def instantiate_datadescription_from_yaml(self) -> DataDescription:
    """Instantiates a DataDescription from a yaml file"""
    with open_location(self.fs_config) as (exp_fs, exp_root):
        data_description: DataDescription = instantiate_from_yaml(
            join(
                exp_root,
                ExperimentFilenames.CONFIGS_FOLDER,
                OpNames.OP_TRAIN.value,
                ExperimentFilenames.DATA_DESCRIPTION,
            ),
            file_system=exp_fs,
        )
    return data_description
read_csv 
read_csv(data_path)

Reads a csv file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
84
85
86
87
def read_csv(self, data_path: str) -> pd.DataFrame:
    """Reads a csv file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        return read_csv(join(root_path, data_path), file_system=file_system)
read_image 
read_image(data_path)

Reads an image relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
139
140
141
142
def read_image(self, data_path: str) -> Image.Image:
    """Reads an image relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        return read_image(join(root_path, data_path), file_system=file_system)
read_json 
read_json(data_path)

reads the json file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
125
126
127
128
def read_json(self, data_path: str) -> dict:
    """reads the json file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        return read_json(join(root_path, data_path), file_system=file_system)
read_parquet 
read_parquet(data_path)

reads the dataframe as parquet file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
60
61
62
63
def read_parquet(self, data_path: str) -> pd.DataFrame:
    """reads the dataframe as parquet file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        return read_parquet(join(root_path, data_path), file_system=file_system)
read_yaml 
read_yaml(data_path)

reads the yaml file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
65
66
67
68
def read_yaml(self, data_path: str) -> dict:
    """reads the yaml file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        return read_yaml(join(root_path, data_path), file_system=file_system)
update_last_modified 
update_last_modified(timestamp=None)

Updates the last modified timestamp of the experiment info

Source code in niceml/experiments/experimentcontext.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
def update_last_modified(self, timestamp: Optional[str] = None):
    """Updates the last modified timestamp of the experiment info"""
    timestamp = timestamp or generate_timestamp()
    try:
        exp_info_dict = self.read_yaml(ExperimentFilenames.EXP_INFO)
        exp_info_dict[LAST_MODIFIED_KEY] = timestamp
        self.write_yaml(
            exp_info_dict, ExperimentFilenames.EXP_INFO, apply_last_modified=False
        )
    except FileNotFoundError:
        logging.getLogger(__name__).warning(
            "Could not update last modified timestamp, because the "
            "experiment info file was not found."
        )
write_csv 
write_csv(
    data, data_path, apply_last_modified=True, **kwargs
)

Writes a csv file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def write_csv(
    self,
    data: pd.DataFrame,
    data_path: str,
    apply_last_modified: bool = True,
    **kwargs,
):
    """Writes a csv file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        write_csv(
            data,
            join(root_path, data_path),
            file_system=file_system,
            **kwargs,
        )
    if apply_last_modified:
        self.update_last_modified()
write_image 
write_image(image, data_path, apply_last_modified=True)

Writes an image relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
130
131
132
133
134
135
136
137
def write_image(
    self, image: Image.Image, data_path: str, apply_last_modified: bool = True
):
    """Writes an image relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        write_image(image, join(root_path, data_path), file_system=file_system)
    if apply_last_modified:
        self.update_last_modified()
write_json 
write_json(
    data, data_path, apply_last_modified=True, **kwargs
)

Writes a json file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def write_json(
    self,
    data: dict,
    data_path: str,
    apply_last_modified: bool = True,
    **kwargs,
):
    """Writes a json file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        write_json(
            data,
            join(root_path, data_path),
            file_system=file_system,
            **kwargs,
        )
    if apply_last_modified:
        self.update_last_modified()
write_parquet 
write_parquet(
    dataframe,
    data_path,
    compression="gzip",
    apply_last_modified=True,
    **kwargs
)

writes the dataframe as parquet file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def write_parquet(
    self,
    dataframe: pd.DataFrame,
    data_path: str,
    compression: Optional[str] = "gzip",
    apply_last_modified: bool = True,
    **kwargs,
):
    """writes the dataframe as parquet file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        write_parquet(
            dataframe,
            # TODO: change with join_fs_path
            join(root_path, data_path),
            compression=compression,
            file_system=file_system,
            **kwargs,
        )
    if apply_last_modified:
        self.update_last_modified()
write_yaml 
write_yaml(
    data, data_path, apply_last_modified=True, **kwargs
)

writes the yaml file relative to the experiment

Source code in niceml/experiments/experimentcontext.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
def write_yaml(
    self, data: dict, data_path: str, apply_last_modified: bool = True, **kwargs
):
    """writes the yaml file relative to the experiment"""
    with open_location(self.fs_config) as (file_system, root_path):
        write_yaml(
            data,
            join(root_path, data_path),
            file_system=file_system,
            **kwargs,
        )
    if apply_last_modified:
        self.update_last_modified()

Functions