Documentation for OutputSettings
Configuration class that specifies the format in which the results are saved. Results can be saved to a MongoDB or a simple son-file. You can also choose whether to save predictions and/or feature importances.
__init__(self, mongodb_connect_url=None, save_output=True, overwrite_results=False, generate_best_model=True, user_id='', wizard_object_id='', wizard_project_name='', project_folder='')
special
Initialize the object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
mongodb_connect_url |
str |
Valid mongodb connection url that specifies a database for storing the results. |
None |
save_output |
bool |
Controls the general saving of the results. |
True |
overwrite_results |
bool |
Allows overwriting the results folder if it already exists. |
False |
generate_best_model |
bool |
Determines whether an optimum_pipe should be created and fitted. If False, no dependent files are created. |
True |
user_id |
str |
The user name of the according PHOTONAI Wizard login. |
'' |
wizard_object_id |
str |
The object id to map the designed pipeline in the PHOTONAI Wizard to the results in the PHOTONAI CORE Database. |
'' |
wizard_project_name |
str |
How the project is titled in the PHOTONAI Wizard. |
'' |
project_folder |
str |
Deprecated Parameter - transferred to Hyperpipe. |
'' |
Source code in photonai/base/hyperpipe.py
def __init__(self,
mongodb_connect_url: str = None,
save_output: bool = True,
overwrite_results: bool = False,
generate_best_model: bool = True,
user_id: str = '',
wizard_object_id: str = '',
wizard_project_name: str = '',
project_folder: str = ''):
"""
Initialize the object.
Parameters:
mongodb_connect_url:
Valid mongodb connection url that specifies a database for storing the results.
save_output:
Controls the general saving of the results.
overwrite_results:
Allows overwriting the results folder if it already exists.
generate_best_model:
Determines whether an optimum_pipe should be created and fitted.
If False, no dependent files are created.
user_id:
The user name of the according PHOTONAI Wizard login.
wizard_object_id:
The object id to map the designed pipeline in the PHOTONAI Wizard
to the results in the PHOTONAI CORE Database.
wizard_project_name:
How the project is titled in the PHOTONAI Wizard.
project_folder:
Deprecated Parameter - transferred to Hyperpipe.
"""
if project_folder:
msg = "Deprecated: The parameter 'project_folder' was moved to the Hyperpipe. " \
"Please use Hyperpipe(..., project_folder='')."
logger.error(msg)
raise DeprecationWarning(msg)
self.mongodb_connect_url = mongodb_connect_url
self.overwrite_results = overwrite_results
self.user_id = user_id
self.wizard_object_id = wizard_object_id
self.wizard_project_name = wizard_project_name
self.generate_best_model = generate_best_model
self.save_output = save_output
self.save_predictions_from_best_config_inner_folds = None
self.verbosity = 0
self.results_folder = ''
self.project_folder = ''
self.log_file = ''
self.logging_file_handler = None