class Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::JobCreateParameters

Parameters supplied to the Create operation.

Attributes

caffe2settings[RW]

@return [Caffe2Settings] Specifies the settings for Caffe2 job.

caffe_settings[RW]

@return [CaffeSettings] Specifies the settings for Caffe job.

chainer_settings[RW]

@return [ChainerSettings] Specifies the settings for Chainer job.

cluster[RW]

@return [ResourceId] Specifies the Id of the cluster on which this job will run.

cntk_settings[RW]

@return [CNTKsettings] Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.

constraints[RW]

@return [JobBasePropertiesConstraints] Constraints associated with the Job.

container_settings[RW]

@return [ContainerSettings] If provided the job will run in the specified container. If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.

custom_toolkit_settings[RW]

@return [CustomToolkitSettings] Specifies the settings for custom tool kit job.

environment_variables[RW]

@return [Array<EnvironmentSetting>] Additional environment variables to set on the job. Batch AI service sets the following environment variables for all jobs: AZ_BATCHAI_INPUT_id, AZ_BATCHAI_OUTPUT_id, AZ_BATCHAI_NUM_GPUS_PER_NODE. For distributed TensorFlow jobs, following additional environment variables are set by the Batch AI Service: AZ_BATCHAI_PS_HOSTS, AZ_BATCHAI_WORKER_HOSTS

experiment_name[RW]

@return [String] Describe the experiment information of the job

input_directories[RW]

@return [Array<InputDirectory>] Specifies the list of input directories for the Job.

job_preparation[RW]

@return [JobPreparation] Specifies the command line to be executed before tool kit is launched. The specified actions will run on all the nodes that are part of the job

location[RW]

@return [String] The region in which to create the job.

node_count[RW]

@return [Integer] Number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes

output_directories[RW]

@return [Array<OutputDirectory>] Specifies the list of output directories where the models will be created. .

priority[RW]

@return [Integer] Priority associated with the job. Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. Default value: 0 .

std_out_err_path_prefix[RW]

@return [String] The path where the Batch AI service will upload stdout and stderror of the job.

tags[RW]

@return [Hash{String => String}] The user specified tags associated with the job.

tensor_flow_settings[RW]

@return [TensorFlowSettings] Specifies the settings for Tensor Flow job.

Public Class Methods

mapper() click to toggle source

Mapper for JobCreateParameters class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job_create_parameters.rb, line 100
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'JobCreateParameters',
    type: {
      name: 'Composite',
      class_name: 'JobCreateParameters',
      model_properties: {
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        experiment_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.experimentName',
          type: {
            name: 'String'
          }
        },
        priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.priority',
          default_value: 0,
          type: {
            name: 'Number'
          }
        },
        cluster: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.cluster',
          type: {
            name: 'Composite',
            class_name: 'ResourceId'
          }
        },
        node_count: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.nodeCount',
          type: {
            name: 'Number'
          }
        },
        container_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.containerSettings',
          type: {
            name: 'Composite',
            class_name: 'ContainerSettings'
          }
        },
        cntk_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.cntkSettings',
          type: {
            name: 'Composite',
            class_name: 'CNTKsettings'
          }
        },
        tensor_flow_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tensorFlowSettings',
          type: {
            name: 'Composite',
            class_name: 'TensorFlowSettings'
          }
        },
        caffe_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.caffeSettings',
          type: {
            name: 'Composite',
            class_name: 'CaffeSettings'
          }
        },
        caffe2settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.caffe2Settings',
          type: {
            name: 'Composite',
            class_name: 'Caffe2Settings'
          }
        },
        chainer_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.chainerSettings',
          type: {
            name: 'Composite',
            class_name: 'ChainerSettings'
          }
        },
        custom_toolkit_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.customToolkitSettings',
          type: {
            name: 'Composite',
            class_name: 'CustomToolkitSettings'
          }
        },
        job_preparation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.jobPreparation',
          type: {
            name: 'Composite',
            class_name: 'JobPreparation'
          }
        },
        std_out_err_path_prefix: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.stdOutErrPathPrefix',
          type: {
            name: 'String'
          }
        },
        input_directories: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.inputDirectories',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'InputDirectoryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'InputDirectory'
                }
            }
          }
        },
        output_directories: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.outputDirectories',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'OutputDirectoryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'OutputDirectory'
                }
            }
          }
        },
        environment_variables: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.environmentVariables',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'EnvironmentSettingElementType',
                type: {
                  name: 'Composite',
                  class_name: 'EnvironmentSetting'
                }
            }
          }
        },
        constraints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.constraints',
          type: {
            name: 'Composite',
            class_name: 'JobBasePropertiesConstraints'
          }
        }
      }
    }
  }
end