ArmMachineLearningModelFactory.MachineLearningCommandJob Method

Reference

Definition

Namespace:: Azure.ResourceManager.MachineLearning.Models

Assembly:: Azure.ResourceManager.MachineLearning.dll

Package:: Azure.ResourceManager.MachineLearning v1.2.0-beta.3

Source:: ArmMachineLearningModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of MachineLearningCommandJob.

public static Azure.ResourceManager.MachineLearning.Models.MachineLearningCommandJob MachineLearningCommandJob (string description = default, System.Collections.Generic.IDictionary<string,string> properties = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.ResourceIdentifier componentId = default, Azure.Core.ResourceIdentifier computeId = default, string displayName = default, string experimentName = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration identity = default, bool? isArchived = default, Azure.ResourceManager.MachineLearning.Models.NotificationSetting notificationSetting = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.SecretConfiguration> secretsConfiguration = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> services = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus? status = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningFlowAutoLoggerState? mlflowAutologger = default, Azure.Core.ResourceIdentifier codeId = default, string command = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningDistributionConfiguration distribution = default, Azure.Core.ResourceIdentifier environmentId = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobInput> inputs = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningCommandJobLimits limits = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> outputs = default, BinaryData parameters = default, Azure.ResourceManager.MachineLearning.Models.JobQueueSettings queueSettings = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobResourceConfiguration resources = default);

static member MachineLearningCommandJob : string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * string * string * Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration * Nullable<bool> * Azure.ResourceManager.MachineLearning.Models.NotificationSetting * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.SecretConfiguration> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningFlowAutoLoggerState> * Azure.Core.ResourceIdentifier * string * Azure.ResourceManager.MachineLearning.Models.MachineLearningDistributionConfiguration * Azure.Core.ResourceIdentifier * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobInput> * Azure.ResourceManager.MachineLearning.Models.MachineLearningCommandJobLimits * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> * BinaryData * Azure.ResourceManager.MachineLearning.Models.JobQueueSettings * Azure.ResourceManager.MachineLearning.Models.MachineLearningJobResourceConfiguration -> Azure.ResourceManager.MachineLearning.Models.MachineLearningCommandJob

Public Shared Function MachineLearningCommandJob (Optional description As String = Nothing, Optional properties As IDictionary(Of String, String) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional componentId As ResourceIdentifier = Nothing, Optional computeId As ResourceIdentifier = Nothing, Optional displayName As String = Nothing, Optional experimentName As String = Nothing, Optional identity As MachineLearningIdentityConfiguration = Nothing, Optional isArchived As Nullable(Of Boolean) = Nothing, Optional notificationSetting As NotificationSetting = Nothing, Optional secretsConfiguration As IDictionary(Of String, SecretConfiguration) = Nothing, Optional services As IDictionary(Of String, MachineLearningJobService) = Nothing, Optional status As Nullable(Of MachineLearningJobStatus) = Nothing, Optional mlflowAutologger As Nullable(Of MachineLearningFlowAutoLoggerState) = Nothing, Optional codeId As ResourceIdentifier = Nothing, Optional command As String = Nothing, Optional distribution As MachineLearningDistributionConfiguration = Nothing, Optional environmentId As ResourceIdentifier = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional inputs As IDictionary(Of String, MachineLearningJobInput) = Nothing, Optional limits As MachineLearningCommandJobLimits = Nothing, Optional outputs As IDictionary(Of String, MachineLearningJobOutput) = Nothing, Optional parameters As BinaryData = Nothing, Optional queueSettings As JobQueueSettings = Nothing, Optional resources As MachineLearningJobResourceConfiguration = Nothing) As MachineLearningCommandJob

Parameters

description: String

The asset description text.

properties: IDictionary<String,String>

The asset property dictionary.

tags: IDictionary<String,String>

Tag dictionary. Tags can be added, removed, and updated.

componentId: ResourceIdentifier

ARM resource ID of the component resource.

computeId: ResourceIdentifier

ARM resource ID of the compute resource.

displayName: String

Display name of job.

experimentName: String

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

identity: MachineLearningIdentityConfiguration

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. Please note MachineLearningIdentityConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmlToken, MachineLearningManagedIdentity and MachineLearningUserIdentity.

isArchived: Nullable<Boolean>

Is the asset archived?.

notificationSetting: NotificationSetting

Notification setting for the job.

secretsConfiguration: IDictionary<String,SecretConfiguration>

Configuration for secrets to be made available during runtime.

services: IDictionary<String,MachineLearningJobService>

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

status: Nullable<MachineLearningJobStatus>

Status of the job.

mlflowAutologger: Nullable<MachineLearningFlowAutoLoggerState>

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

codeId: ResourceIdentifier

ARM resource ID of the code asset.

command: String

[Required] The command to execute on startup of the job. eg. "python train.py".

distribution: MachineLearningDistributionConfiguration

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, Ray, or null. Please note MachineLearningDistributionConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MpiDistributionConfiguration, PyTorchDistributionConfiguration, RayDistributionConfiguration and TensorFlowDistributionConfiguration.