JobCreateParameters Class

Job creation parameters.

Inheritance

Model

JobCreateParameters

Constructor

JobCreateParameters(*, scheduling_priority: Optional[Union[str, azure.mgmt.batchai.models._batch_ai_enums.JobPriority]] = None, cluster: Optional[azure.mgmt.batchai.models._models_py3.ResourceId] = None, mount_volumes: Optional[azure.mgmt.batchai.models._models_py3.MountVolumes] = None, node_count: Optional[int] = None, container_settings: Optional[azure.mgmt.batchai.models._models_py3.ContainerSettings] = None, cntk_settings: Optional[azure.mgmt.batchai.models._models_py3.CNTKsettings] = None, py_torch_settings: Optional[azure.mgmt.batchai.models._models_py3.PyTorchSettings] = None, tensor_flow_settings: Optional[azure.mgmt.batchai.models._models_py3.TensorFlowSettings] = None, caffe_settings: Optional[azure.mgmt.batchai.models._models_py3.CaffeSettings] = None, caffe2_settings: Optional[azure.mgmt.batchai.models._models_py3.Caffe2Settings] = None, chainer_settings: Optional[azure.mgmt.batchai.models._models_py3.ChainerSettings] = None, custom_toolkit_settings: Optional[azure.mgmt.batchai.models._models_py3.CustomToolkitSettings] = None, custom_mpi_settings: Optional[azure.mgmt.batchai.models._models_py3.CustomMpiSettings] = None, horovod_settings: Optional[azure.mgmt.batchai.models._models_py3.HorovodSettings] = None, job_preparation: Optional[azure.mgmt.batchai.models._models_py3.JobPreparation] = None, std_out_err_path_prefix: Optional[str] = None, input_directories: Optional[List[azure.mgmt.batchai.models._models_py3.InputDirectory]] = None, output_directories: Optional[List[azure.mgmt.batchai.models._models_py3.OutputDirectory]] = None, environment_variables: Optional[List[azure.mgmt.batchai.models._models_py3.EnvironmentVariable]] = None, secrets: Optional[List[azure.mgmt.batchai.models._models_py3.EnvironmentVariableWithSecretValue]] = None, constraints: Optional[azure.mgmt.batchai.models._models_py3.JobBasePropertiesConstraints] = None, **kwargs)

Parameters

scheduling_priority

str or <xref:batch_ai.models.JobPriority>

Required

Scheduling priority associated with the job. Possible values: low, normal, high. Possible values include: "low", "normal", "high".

cluster

<xref:batch_ai.models.ResourceId>

Required

Resource ID of the cluster on which this job will run.

mount_volumes

<xref:batch_ai.models.MountVolumes>

Required

Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.

node_count

int

Required

Number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes.

container_settings

<xref:batch_ai.models.ContainerSettings>

Required

Docker container settings for the job. If not provided, the job will run directly on the node.

cntk_settings

<xref:batch_ai.models.CNTKsettings>

Required

Settings for CNTK (aka Microsoft Cognitive Toolkit) job.

py_torch_settings

<xref:batch_ai.models.PyTorchSettings>

Required

Settings for pyTorch job.

tensor_flow_settings

<xref:batch_ai.models.TensorFlowSettings>

Required

Settings for Tensor Flow job.

caffe_settings

<xref:batch_ai.models.CaffeSettings>

Required

Settings for Caffe job.

caffe2_settings

<xref:batch_ai.models.Caffe2Settings>

Required

Settings for Caffe2 job.

chainer_settings

<xref:batch_ai.models.ChainerSettings>

Required

Settings for Chainer job.

custom_toolkit_settings

<xref:batch_ai.models.CustomToolkitSettings>

Required

Settings for custom tool kit job.

custom_mpi_settings

<xref:batch_ai.models.CustomMpiSettings>

Required

Settings for custom MPI job.

horovod_settings

<xref:batch_ai.models.HorovodSettings>

Required

Settings for Horovod job.

job_preparation

<xref:batch_ai.models.JobPreparation>

Required

A command line to be executed on each node allocated for the job before tool kit is launched.

std_out_err_path_prefix

str

Required

The path where the Batch AI service will store stdout, stderror and execution log of the job.

input_directories

list[<xref:batch_ai.models.InputDirectory>]

Required

A list of input directories for the job.

output_directories

list[<xref:batch_ai.models.OutputDirectory>]

Required

A list of output directories for the job.

environment_variables

list[<xref:batch_ai.models.EnvironmentVariable>]

Required

A list of user defined environment variables which will be setup for the job.

secrets

list[<xref:batch_ai.models.EnvironmentVariableWithSecretValue>]

Required

A list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back.

constraints

<xref:batch_ai.models.JobBasePropertiesConstraints>

Required

Constraints associated with the Job.