idmtools.core.docker_task module

class idmtools.core.docker_task.DockerTask(command: Union[str, idmtools.entities.command_line.CommandLine] = None, platform_requirements: Set[idmtools.entities.platform_requirements.PlatformRequirements] = <factory>, _ITask__pre_creation_hooks: List[Callable[[Union[ForwardRef('Simulation'), ForwardRef('IWorkflowItem')]], NoReturn]] = <factory>, _ITask__post_creation_hooks: List[Callable[[Union[ForwardRef('Simulation'), ForwardRef('IWorkflowItem')]], NoReturn]] = <factory>, common_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, transient_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, _task_log: logging.Logger = <factory>, image_name: str = None, build: bool = False, build_path: Union[str, NoneType] = None, Dockerfile: Union[str, NoneType] = None, pull_before_build: bool = True, use_nvidia_run: bool = False, _DockerTask__image_built: bool = False)

Bases: idmtools.entities.itask.ITask

image_name: str = None

build: bool = False

build_path: Optional[str] = None

Dockerfile: Optional[str] = None

pull_before_build: bool = True

use_nvidia_run: bool = False

gather_common_assets() → idmtools.assets.asset_collection.AssetCollection

Gather common(experiment-level) assets from task

Returns

AssetCollection containing all the common assets

gather_transient_assets() → idmtools.assets.asset_collection.AssetCollection

Gather transient(simulation-level) assets from task

Returns

AssetCollection

build_image(spinner=None, **extra_build_args)

reload_from_simulation(simulation: Simulation)

Optional hook that is called when loading simulations from a platform

class idmtools.core.docker_task.DockerTaskSpecification

Bases: idmtools.registry.task_specification.TaskSpecification

get(configuration: dict) → idmtools.core.docker_task.DockerTask

Get instance of DockerTask with configuration provided

Parameters

configuration – configuration for DockerTask

Returns

DockerTask with configuration

get_description() → str

Get description of plugin

Returns

Plugin description

get_type() → Type[idmtools.core.docker_task.DockerTask]

Get type of task provided by plugin

Returns

DockerTask