IExperiment

Object to simplify experiment creation, configuration and run. This can be used in a Jupyter Notebook

:raises Exception: [description] :return: [description] :rtype: [type]

__INIT__

This create an experiment in the database with the provided Task or Protocol

                If this is a task, it will be wrapped in a protocol
                If none it will create an empty protocol in the experiment

:raises Exception: [description]

Parameters:

Name	Type	Default value	Description
protocol_type	`Type`
project	`Project`		Experiment title, defaults to '' str, optional
title	`str`	''	Experiment title, defaults to '' , optional
creation_type	`ExperimentCreationType`	ExperimentCreationType.AUTO	Type of the created experiment, defaults to experimentexecutiontype.auto experimentexecutiontype, optional

ADD_TAG

Parameters:

Name	Type	Default value	Description
tag	`Tag`

ADD_TAGS

Parameters:

Name	Type	Default value	Description
tags	`List`

DELETE

GET_MODEL

Return type:

Experiment

GET_PROTOCOL

retrieve the main protocol of the experiment

Return type:

IProtocol

IS_FINISHED

Return type:

bool

IS_RUNNING

Return type:

bool

IS_SUCCESS

Return type:

bool

REFRESH

Return type:

IExperiment

RUN

execute the experiment, after that the resource should be generated and can be retrieve by process

Parameters:

Name	Type	Default value	Description
auto_delete_if_error	`bool`	False

STOP