idmtools.entities.suite module#

Defines our Suite object.

The Suite object can be thought as a metadata object. It represents a container object for Experiments. All Suites should have one or more experiments.

class idmtools.entities.suite.Suite(_uid: str = None, _IItem__pre_creation_hooks: ~typing.List[~typing.Callable[[IItem, IPlatform], None]] = <factory>, _IItem__post_creation_hooks: ~typing.List[~typing.Callable[[IItem, IPlatform], None]] = <factory>, platform_id: str = None, _platform: IPlatform = None, parent_id: str = None, _parent: IEntity = None, status: ~idmtools.core.enums.EntityStatus = None, tags: ~typing.Dict[str, ~typing.Any] = <factory>, _platform_object: ~typing.Any = None, _IRunnableEntity__pre_run_hooks: ~typing.List[~typing.Callable[[IRunnableEntity, IPlatform], None]] = <factory>, _IRunnableEntity__post_run_hooks: ~typing.List[~typing.Callable[[IRunnableEntity, IPlatform], None]] = <factory>, name: str = None, experiments: ~idmtools.core.interfaces.entity_container.EntityContainer = <factory>, description: str = None)[source]#

Bases: INamedEntity, ABC, IRunnableEntity

Class that represents a generic suite (a collection of experiments).

Parameters:: experiments – The child items of this suite.

experiments: EntityContainer#

item_type: ItemType = 'Suite'#: Item Type(Experiment, Suite, Asset, etc)

description: str = None#

add_experiment(experiment: Experiment) → NoReturn[source]#

Add an experiment to the suite.

Parameters:: experiment – the experiment to be linked to suite

display()[source]#

Display workflowitem.

Returns:: None

pre_creation(platform: IPlatform)[source]#

Pre Creation of IWorkflowItem.

Parameters:: platform – Platform we are creating item on
Returns:: None

post_creation(platform: IPlatform)[source]#

Post Creation of IWorkflowItem.

Parameters:: platform – Platform
Returns:: None

property done#

Return if an suite has finished executing.

Returns:: True if all experiments have ran, False otherwise

property succeeded: bool#

Return if an suite has succeeded. An suite is succeeded when all experiments have succeeded.

Returns:: True if all experiments have succeeded, False otherwise

to_dict() → Dict[source]#

Converts suite to a dictionary.

Returns:: Dictionary of suite.

__init__(_uid: str = None, _IItem__pre_creation_hooks: ~typing.List[~typing.Callable[[IItem, IPlatform], None]] = <factory>, _IItem__post_creation_hooks: ~typing.List[~typing.Callable[[IItem, IPlatform], None]] = <factory>, platform_id: str = None, _platform: IPlatform = None, parent_id: str = None, _parent: IEntity = None, status: ~idmtools.core.enums.EntityStatus = None, tags: ~typing.Dict[str, ~typing.Any] = <factory>, _platform_object: ~typing.Any = None, _IRunnableEntity__pre_run_hooks: ~typing.List[~typing.Callable[[IRunnableEntity, IPlatform], None]] = <factory>, _IRunnableEntity__post_run_hooks: ~typing.List[~typing.Callable[[IRunnableEntity, IPlatform], None]] = <factory>, name: str = None, experiments: ~idmtools.core.interfaces.entity_container.EntityContainer = <factory>, description: str = None) → None#