metobs_toolkit.dataset.Dataset.save_dataset_to_pkl#

Dataset.save_dataset_to_pkl(target_folder: str | Path, filename: str = 'saved_dataset.pkl', overwrite: bool = False) → None[source]#

Save the dataset to a pickle (.pkl) file.

Parameters:

target_folder (str or Path) – The folder where the pickle file will be saved. Must be an existing directory.
filename (str, optional) – The name of the pickle file. Defaults to “saved_dataset.pkl”. If the provided filename does not have a “.pkl” extension, it will be automatically appended.
overwrite (bool, optional) – Whether to overwrite the file if it already exists. Defaults to False.

Return type:

None