Share via


ArmMachineLearningModelFactory.AutoMLJob Method

Definition

Overloads

AutoMLJob(String, IDictionary<String,String>, IDictionary<String, String>, String, Nullable<MachineLearningJobStatus>, String, IDictionary<String, MachineLearningJobService>, ResourceIdentifier, Nullable<Boolean>, MachineLearningIdentityConfiguration, ResourceIdentifier, NotificationSetting, MachineLearningJobResourceConfiguration, String, IDictionary<String, String>, AutoMLVertical, IDictionary<String,MachineLearningJobOutput>, Nullable<JobTier>)

Initializes a new instance of AutoMLJob.

AutoMLJob(String, IDictionary<String,String>, IDictionary<String, String>, ResourceIdentifier, ResourceIdentifier, String, String, MachineLearningIdentityConfiguration, Nullable<Boolean>, NotificationSetting, IDictionary<String,SecretConfiguration>, IDictionary<String, MachineLearningJobService>, Nullable<MachineLearningJobStatus>, String, IDictionary<String,String>, IDictionary<String,MachineLearningJobOutput>, JobQueueSettings, MachineLearningJobResourceConfiguration, AutoMLVertical)

Initializes a new instance of AutoMLJob.

AutoMLJob(String, IDictionary<String,String>, IDictionary<String, String>, String, Nullable<MachineLearningJobStatus>, String, IDictionary<String, MachineLearningJobService>, ResourceIdentifier, Nullable<Boolean>, MachineLearningIdentityConfiguration, ResourceIdentifier, NotificationSetting, MachineLearningJobResourceConfiguration, String, IDictionary<String, String>, AutoMLVertical, IDictionary<String,MachineLearningJobOutput>, Nullable<JobTier>)

Source:
ArmMachineLearningModelFactory.cs

Initializes a new instance of AutoMLJob.

public static Azure.ResourceManager.MachineLearning.Models.AutoMLJob AutoMLJob (string description = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Collections.Generic.IDictionary<string,string> properties = default, string displayName = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus? status = default, string experimentName = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> services = default, Azure.Core.ResourceIdentifier computeId = default, bool? isArchived = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration identity = default, Azure.Core.ResourceIdentifier componentId = default, Azure.ResourceManager.MachineLearning.Models.NotificationSetting notificationSetting = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobResourceConfiguration resources = default, string environmentId = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, Azure.ResourceManager.MachineLearning.Models.AutoMLVertical taskDetails = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> outputs = default, Azure.ResourceManager.MachineLearning.Models.JobTier? queueJobTier = default);
static member AutoMLJob : string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * string * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus> * string * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> * Azure.Core.ResourceIdentifier * Nullable<bool> * Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration * Azure.Core.ResourceIdentifier * Azure.ResourceManager.MachineLearning.Models.NotificationSetting * Azure.ResourceManager.MachineLearning.Models.MachineLearningJobResourceConfiguration * string * System.Collections.Generic.IDictionary<string, string> * Azure.ResourceManager.MachineLearning.Models.AutoMLVertical * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> * Nullable<Azure.ResourceManager.MachineLearning.Models.JobTier> -> Azure.ResourceManager.MachineLearning.Models.AutoMLJob
Public Shared Function AutoMLJob (Optional description As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional properties As IDictionary(Of String, String) = Nothing, Optional displayName As String = Nothing, Optional status As Nullable(Of MachineLearningJobStatus) = Nothing, Optional experimentName As String = Nothing, Optional services As IDictionary(Of String, MachineLearningJobService) = Nothing, Optional computeId As ResourceIdentifier = Nothing, Optional isArchived As Nullable(Of Boolean) = Nothing, Optional identity As MachineLearningIdentityConfiguration = Nothing, Optional componentId As ResourceIdentifier = Nothing, Optional notificationSetting As NotificationSetting = Nothing, Optional resources As MachineLearningJobResourceConfiguration = Nothing, Optional environmentId As String = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional taskDetails As AutoMLVertical = Nothing, Optional outputs As IDictionary(Of String, MachineLearningJobOutput) = Nothing, Optional queueJobTier As Nullable(Of JobTier) = Nothing) As AutoMLJob

Parameters

description
String

The asset description text.

tags
IDictionary<String,String>

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

properties
IDictionary<String,String>

The asset property dictionary.

displayName
String

Display name of job.

status
Nullable<MachineLearningJobStatus>

Status of the job.

experimentName
String

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

services
IDictionary<String,MachineLearningJobService>

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

computeId
ResourceIdentifier

ARM resource ID of the compute resource.

isArchived
Nullable<Boolean>

Is the asset archived?.

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.

componentId
ResourceIdentifier

ARM resource ID of the component resource.

notificationSetting
NotificationSetting

Notification setting for the job.

resources
MachineLearningJobResourceConfiguration

Compute Resource configuration for the job.

environmentId
String

The ARM resource ID of the Environment specification for the job. This is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.

environmentVariables
IDictionary<String,String>

Environment variables included in the job.

taskDetails
AutoMLVertical

[Required] This represents scenario which can be one of Tables/NLP/Image Please note AutoMLVertical 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 ClassificationTask, MachineLearningForecasting, ImageClassification, ImageClassificationMultilabel, ImageInstanceSegmentation, ImageObjectDetection, AutoMLVerticalRegression, TextClassification, TextClassificationMultilabel and TextNer.

outputs
IDictionary<String,MachineLearningJobOutput>

Mapping of output data bindings used in the job. Please note MachineLearningJobOutput 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 MachineLearningCustomModelJobOutput, MachineLearningFlowModelJobOutput, MachineLearningTableJobOutput, MachineLearningTritonModelJobOutput, MachineLearningUriFileJobOutput and MachineLearningUriFolderJobOutput.

queueJobTier
Nullable<JobTier>

Queue settings for the job.

Returns

A new AutoMLJob instance for mocking.

Applies to

AutoMLJob(String, IDictionary<String,String>, IDictionary<String, String>, ResourceIdentifier, ResourceIdentifier, String, String, MachineLearningIdentityConfiguration, Nullable<Boolean>, NotificationSetting, IDictionary<String,SecretConfiguration>, IDictionary<String, MachineLearningJobService>, Nullable<MachineLearningJobStatus>, String, IDictionary<String,String>, IDictionary<String,MachineLearningJobOutput>, JobQueueSettings, MachineLearningJobResourceConfiguration, AutoMLVertical)

Source:
ArmMachineLearningModelFactory.cs

Initializes a new instance of AutoMLJob.

public static Azure.ResourceManager.MachineLearning.Models.AutoMLJob AutoMLJob (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, string environmentId = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> outputs = default, Azure.ResourceManager.MachineLearning.Models.JobQueueSettings queueSettings = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobResourceConfiguration resources = default, Azure.ResourceManager.MachineLearning.Models.AutoMLVertical taskDetails = default);
static member AutoMLJob : 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> * string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> * Azure.ResourceManager.MachineLearning.Models.JobQueueSettings * Azure.ResourceManager.MachineLearning.Models.MachineLearningJobResourceConfiguration * Azure.ResourceManager.MachineLearning.Models.AutoMLVertical -> Azure.ResourceManager.MachineLearning.Models.AutoMLJob
Public Shared Function AutoMLJob (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 environmentId As String = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional outputs As IDictionary(Of String, MachineLearningJobOutput) = Nothing, Optional queueSettings As JobQueueSettings = Nothing, Optional resources As MachineLearningJobResourceConfiguration = Nothing, Optional taskDetails As AutoMLVertical = Nothing) As AutoMLJob

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.

environmentId
String

The ARM resource ID of the Environment specification for the job. This is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.

environmentVariables
IDictionary<String,String>

Environment variables included in the job.

outputs
IDictionary<String,MachineLearningJobOutput>

Mapping of output data bindings used in the job. Please note MachineLearningJobOutput 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 MachineLearningCustomModelJobOutput, MachineLearningFlowModelJobOutput, MachineLearningTableJobOutput, MachineLearningTritonModelJobOutput, MachineLearningUriFileJobOutput and MachineLearningUriFolderJobOutput.

queueSettings
JobQueueSettings

Queue settings for the job.

resources
MachineLearningJobResourceConfiguration

Compute Resource configuration for the job.

taskDetails
AutoMLVertical

[Required] This represents scenario which can be one of Tables/NLP/Image Please note AutoMLVertical 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 ClassificationTask, MachineLearningForecasting, ImageClassification, ImageClassificationMultilabel, ImageInstanceSegmentation, ImageObjectDetection, AutoMLVerticalRegression, TextClassification, TextClassificationMultilabel and TextNer.

Returns

A new AutoMLJob instance for mocking.

Applies to