local_experiment_saver

class aitoolbox.experiment.local_experiment_saver.BaseFullExperimentLocalSaver(model_saver, project_name, experiment_name, local_model_result_folder_path='~/project/model_result')

Bases: AbstractExperimentSaver

Base functionality class common to all the full experiment local saver derivations

Parameters:

• model_saver (aitoolbox.experiment.local_save.local_model_save.AbstractLocalModelSaver) – selected model saver implementing the saving logic for the desired framework

• project_name (str) – root name of the project

• experiment_name (str) – name of the particular experiment

• local_model_result_folder_path (str) – root local path where project folder will be created

save_experiment(model, result_package, training_history, experiment_timestamp=None, save_true_pred_labels=False, separate_files=False, protect_existing_folder=True)

Save the experiment with the provided model saver

Parameters:

• model (dict or keras.Model) – model representation. If used with PyTorch it is a simple dict under the hood. In the case of Keras training this would be the keras Model.

• result_package (aitoolbox.experiment.result_package.abstract_result_packages.AbstractResultPackage) – selected result package which will be evaluated to produce the performance results

• training_history (aitoolbox.experiment.training_history.TrainingHistory) –

• experiment_timestamp (str) – time stamp at the start of training

• save_true_pred_labels (bool) – should ground truth labels also be saved

• separate_files (bool) – should the results be saved in separate pickle files or should all the results be batched together in a single results file

• protect_existing_folder (bool) – can override potentially already existing folder or not

Returns:

local model and results paths

Return type:

list

class aitoolbox.experiment.local_experiment_saver.FullPyTorchExperimentLocalSaver(project_name, experiment_name, local_model_result_folder_path='~/project/model_result')

Bases: BaseFullExperimentLocalSaver

PyTorch local experiment saver

Parameters:

• project_name (str) – root name of the project

• experiment_name (str) – name of the particular experiment

• local_model_result_folder_path (str) – root local path where project folder will be created

class aitoolbox.experiment.local_experiment_saver.FullKerasExperimentLocalSaver(project_name, experiment_name, local_model_result_folder_path='~/project/model_result')

Bases: BaseFullExperimentLocalSaver

Keras local experiment saver

Parameters:

• project_name (str) – root name of the project

• experiment_name (str) – name of the particular experiment

• local_model_result_folder_path (str) – root local path where project folder will be created