py2lispIDyOM.run.IDyOMExperiment

class py2lispIDyOM.run.IDyOMExperiment(test_dataset_path, pretrain_dataset_path=None, experiment_history_folder_path=None, experiment_logger_name=None, idyom_config=<factory>)

A class to configure and run an IDyOM experiment

Parameters:

• test_dataset_path (str) – the path to your test dataset (required)

• pretrain_dataset_path (str) – the path to your pretrain dataset

• experiment_history_folder_path (str) – the path to which you want to save all the result data/plots, defaults to None.

• experiment_logger_name (str) – the name of the experiment logger for the current experiment, defaults to the current timestamp.

Public Data Attributes:

pretrain_dataset_path
experiment_history_folder_path
experiment_logger_name
test_dataset_path
idyom_config

Public Methods:

__post_init__()
set_parameters(**kwargs)	Set the IDyOM model parameters.
generate_lisp_script([write])	Generate the LISP script for the IDyOM model configurations.
run()	Run the IDyOM model.
__init__(test_dataset_path[, ...])
__repr__()	Return repr(self).
__eq__(other)	Return self==value.

Private Methods:

_update_idyom_config()
_generate_test_dataset_id()	rtype: str
_generate_train_dataset_id()
_generate_lisp_commands()	Generate the LISP commands for the IDyOM model configurations.

---

generate_lisp_script(write=True)

Generate the LISP script for the IDyOM model configurations.

Parameters:

write (bool) – whether to write the file or not, defaults to True.

Returns:

the path to the lisp script file.

Return type:

str

run()

Run the IDyOM model.

set_parameters(**kwargs)

Set the IDyOM model parameters.

Parameters:

kwargs – see the API reference (the section below) for a complete list of valid parameters (keyword arguments).