Class: Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::Job

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb

Overview

Contains information about the job.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#caffe_settings ⇒ CaffeSettings

Returns Specifies the settings for Caffe job.

Returns:



52
53
54
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 52

def caffe_settings
  @caffe_settings
end

#chainer_settings ⇒ ChainerSettings

Returns Specifies the settings for Chainer job.

Returns:



55
56
57
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 55

def chainer_settings
  @chainer_settings
end

#cluster ⇒ ResourceId

will run.

Returns:

  • (ResourceId) —

    Specifies the Id of the cluster on which this job



26
27
28
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 26

def cluster
  @cluster
end

#cntk_settings ⇒ CNTKsettings

Cognitive Toolkit) job.

Returns:

  • (CNTKsettings) —

    Specifies the settings for CNTK (aka Microsoft



45
46
47
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 45

def cntk_settings
  @cntk_settings
end

#constraints ⇒ JobPropertiesConstraints

Returns Constraints associated with the Job.

Returns:



87
88
89
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 87

def constraints
  @constraints
end

#container_settings ⇒ ContainerSettings

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.

Returns:



36
37
38
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 36

def container_settings
  @container_settings
end

#creation_time ⇒ DateTime

Returns The job creation time. The creation time of the job.

Returns:

  • (DateTime) —

    The job creation time. The creation time of the job.



90
91
92
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 90

def creation_time
  @creation_time
end

#custom_toolkit_settings ⇒ CustomToolkitSettings

kit job.

Returns:



59
60
61
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 59

def custom_toolkit_settings
  @custom_toolkit_settings
end

#environment_variables ⇒ Array<EnvironmentSetting>

be passed to the job. Batch AI services 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.

Returns:



84
85
86
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 84

def environment_variables
  @environment_variables
end

#execution_info ⇒ JobPropertiesExecutionInfo

execution of a job in the Azure Batch service.

Returns:



124
125
126
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 124

def execution_info
  @execution_info
end

#execution_state ⇒ ExecutionState

state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job. Possible values include: ‘queued’, ‘running’, ‘terminating’, ‘succeeded’, ‘failed’

Returns:



115
116
117
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 115

def execution_state
  @execution_state
end

#execution_state_transition_time ⇒ DateTime

execution state. The time at which the job entered its current execution state.

Returns:

  • (DateTime) —

    The time at which the job entered its current



120
121
122
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 120

def execution_state_transition_time
  @execution_state_transition_time
end

#experiment_name ⇒ String

Returns Describe the experiment information of the job.

Returns:

  • (String) —

    Describe the experiment information of the job



16
17
18
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 16

def experiment_name
  @experiment_name
end

#input_directories ⇒ Array<InputDirectory>

for the Job.

Returns:



72
73
74
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 72

def input_directories
  @input_directories
end

#job_preparation ⇒ JobPreparation

tool kit is launched. The specified actions will run on all the nodes that are part of the job

Returns:



64
65
66
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 64

def job_preparation
  @job_preparation
end

#node_count ⇒ Integer

will be gang scheduled on that many compute nodes

Returns:

  • (Integer) —

    Number of compute nodes to run the job on. The job



30
31
32
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 30

def node_count
  @node_count
end

#output_directories ⇒ Array<OutputDirectory>

directories where the models will be created. .

Returns:



76
77
78
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 76

def output_directories
  @output_directories
end

#priority ⇒ Integer

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 .

Returns:

  • (Integer) —

    Priority associated with the job. Priority associated



22
23
24
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 22

def priority
  @priority
end

#provisioning_state ⇒ ProvisioningState

Possible values include: ‘creating’, ‘succeeded’, ‘failed’, ‘deleting’

Returns:



94
95
96
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 94

def provisioning_state
  @provisioning_state
end

#provisioning_state_transition_time ⇒ DateTime

provisioning state. The time at which the job entered its current provisioning state.

Returns:

  • (DateTime) —

    The time at which the job entered its current



99
100
101
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 99

def provisioning_state_transition_time
  @provisioning_state_transition_time
end

#std_out_err_path_prefix ⇒ String

and stderror of the job.

Returns:

  • (String) —

    The path where the Batch AI service will upload stdout



68
69
70
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 68

def std_out_err_path_prefix
  @std_out_err_path_prefix
end

#tensor_flow_settings ⇒ TensorFlowSettings

job.

Returns:



49
50
51
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 49

def tensor_flow_settings
  @tensor_flow_settings
end

#tool_type ⇒ ToolType

cntk, tensorflow, caffe, caffe2, chainer, custom. Possible values include: ‘cntk’, ‘tensorflow’, ‘caffe’, ‘caffe2’, ‘chainer’, ‘custom’

Returns:

  • (ToolType) —

    The toolkit type of this job. Possible values are:



41
42
43
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 41

def tool_type
  @tool_type
end

Class Method Details

.mapper ⇒ Object

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/job.rb', line 131

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Job',
    type: {
      name: 'Composite',
      class_name: 'Job',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          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: false,
          serialized_name: 'properties.cluster',
          type: {
            name: 'Composite',
            class_name: 'ResourceId'
          }
        },
        node_count: {
          client_side_validation: true,
          required: false,
          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'
          }
        },
        tool_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.toolType',
          type: {
            name: 'String'
          }
        },
        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'
          }
        },
        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: false,
          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: 'JobPropertiesConstraints'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        provisioning_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        execution_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.executionState',
          type: {
            name: 'Enum',
            module: 'ExecutionState'
          }
        },
        execution_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.executionStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        execution_info: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.executionInfo',
          type: {
            name: 'Composite',
            class_name: 'JobPropertiesExecutionInfo'
          }
        }
      }
    }
  }
end