Login
Back to bricks list
Introduction Version

IExperiment

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

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

Functions

__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:
NameTypeDefault valueDescription
protocol_typeType
projectProject Experiment title, defaults to '' str, optional
titlestr '' Experiment title, defaults to '' , optional
creation_typeExperimentCreationType ExperimentCreationType.AUTO Type of the created experiment, defaults to experimentexecutiontype.auto experimentexecutiontype, optional
ADD_TAG
Parameters:
NameTypeDefault valueDescription
tagTag
ADD_TAGS
Parameters:
NameTypeDefault valueDescription
tagsList
DELETE
GET_EXPERIMENT_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
RUN

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

Parameters:
NameTypeDefault valueDescription
auto_delete_if_errorbool False
STOP