DockerConfiguration Class

  • Reference

Represents Docker runtime configuration for jobs.

Class DockerConfiguration constructor.

Inheritance
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
DockerConfiguration

Constructor

DockerConfiguration(use_docker=False, shared_volumes=True, arguments=[], shm_size='2g')

Parameters

Name Description
use_docker
bool

Specifies whether the environment to run the experiment should be Docker-based. The default is False.

default value: False
shared_volumes
bool

Indicates whether to use shared volumes. Set to False if necessary to work around shared volume bugs on Windows. The default is True.

default value: True
arguments
list[str]

Extra arguments to pass to the Docker run command. The default is empty list.

default value: []
shm_size
str

The size of the Docker container's shared memory block. If not set, the default azureml.core.environment._DEFAULT_SHM_SIZE is used. For more information, see Docker run reference.

default value: 2g