ArmMachineLearningModelFactory.MachineLearningSweepJob Method

Reference

Definition

Namespace:: Azure.ResourceManager.MachineLearning.Models

Assembly:: Azure.ResourceManager.MachineLearning.dll

Package:: Azure.ResourceManager.MachineLearning v1.2.1

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

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.

Overloads

MachineLearningSweepJob(String, IDictionary<String,String>, IDictionary<String, String>, String, Nullable<MachineLearningJobStatus>, String, IDictionary<String, MachineLearningJobService>, ResourceIdentifier, Nullable<Boolean>, MachineLearningIdentityConfiguration, ResourceIdentifier, NotificationSetting, BinaryData, SamplingAlgorithm, MachineLearningSweepJobLimits, MachineLearningEarlyTerminationPolicy, MachineLearningObjective, MachineLearningTrialComponent, IDictionary<String,MachineLearningJobInput>, IDictionary<String,MachineLearningJobOutput>, Nullable<JobTier>)

Initializes a new instance of MachineLearningSweepJob.

MachineLearningSweepJob(String, IDictionary<String,String>, IDictionary<String, String>, ResourceIdentifier, ResourceIdentifier, String, String, MachineLearningIdentityConfiguration, Nullable<Boolean>, NotificationSetting, IDictionary<String,SecretConfiguration>, IDictionary<String, MachineLearningJobService>, Nullable<MachineLearningJobStatus>, MachineLearningEarlyTerminationPolicy, IDictionary<String,MachineLearningJobInput>, MachineLearningSweepJobLimits, MachineLearningObjective, IDictionary<String, MachineLearningJobOutput>, JobQueueSettings, SamplingAlgorithm, BinaryData, MachineLearningTrialComponent)

Initializes a new instance of MachineLearningSweepJob.

MachineLearningSweepJob(String, IDictionary<String,String>, IDictionary<String, String>, String, Nullable<MachineLearningJobStatus>, String, IDictionary<String, MachineLearningJobService>, ResourceIdentifier, Nullable<Boolean>, MachineLearningIdentityConfiguration, ResourceIdentifier, NotificationSetting, BinaryData, SamplingAlgorithm, MachineLearningSweepJobLimits, MachineLearningEarlyTerminationPolicy, MachineLearningObjective, MachineLearningTrialComponent, IDictionary<String,MachineLearningJobInput>, IDictionary<String,MachineLearningJobOutput>, Nullable<JobTier>)

Source:: ArmMachineLearningModelFactory.cs

Initializes a new instance of MachineLearningSweepJob.

public static Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJob MachineLearningSweepJob (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, BinaryData searchSpace = default, Azure.ResourceManager.MachineLearning.Models.SamplingAlgorithm samplingAlgorithm = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJobLimits limits = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningEarlyTerminationPolicy earlyTermination = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningObjective objective = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningTrialComponent trial = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobInput> inputs = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> outputs = default, Azure.ResourceManager.MachineLearning.Models.JobTier? queueJobTier = default);

static member MachineLearningSweepJob : 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 * BinaryData * Azure.ResourceManager.MachineLearning.Models.SamplingAlgorithm * Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJobLimits * Azure.ResourceManager.MachineLearning.Models.MachineLearningEarlyTerminationPolicy * Azure.ResourceManager.MachineLearning.Models.MachineLearningObjective * Azure.ResourceManager.MachineLearning.Models.MachineLearningTrialComponent * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobInput> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> * Nullable<Azure.ResourceManager.MachineLearning.Models.JobTier> -> Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJob

Public Shared Function MachineLearningSweepJob (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 searchSpace As BinaryData = Nothing, Optional samplingAlgorithm As SamplingAlgorithm = Nothing, Optional limits As MachineLearningSweepJobLimits = Nothing, Optional earlyTermination As MachineLearningEarlyTerminationPolicy = Nothing, Optional objective As MachineLearningObjective = Nothing, Optional trial As MachineLearningTrialComponent = Nothing, Optional inputs As IDictionary(Of String, MachineLearningJobInput) = Nothing, Optional outputs As IDictionary(Of String, MachineLearningJobOutput) = Nothing, Optional queueJobTier As Nullable(Of JobTier) = Nothing) As MachineLearningSweepJob

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.

searchSpace: BinaryData

[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter.

samplingAlgorithm: SamplingAlgorithm

[Required] The hyperparameter sampling algorithm Please note SamplingAlgorithm 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 BayesianSamplingAlgorithm, GridSamplingAlgorithm and RandomSamplingAlgorithm.

limits: MachineLearningSweepJobLimits

Sweep Job limit.

earlyTermination: MachineLearningEarlyTerminationPolicy

Early termination policies enable canceling poor-performing runs before they complete Please note MachineLearningEarlyTerminationPolicy 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 BanditPolicy, MedianStoppingPolicy and TruncationSelectionPolicy.

objective: MachineLearningObjective

[Required] Optimization objective.

trial: MachineLearningTrialComponent

[Required] Trial component definition.

inputs: IDictionary<String,MachineLearningJobInput>

Mapping of input data bindings used in the job. Please note MachineLearningJobInput 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 MachineLearningCustomModelJobInput, MachineLearningLiteralJobInput, MachineLearningFlowModelJobInput, MachineLearningTableJobInput, MachineLearningTritonModelJobInput, MachineLearningUriFileJobInput and MachineLearningUriFolderJobInput.

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

MachineLearningSweepJob

A new MachineLearningSweepJob instance for mocking.

Applies to

MachineLearningSweepJob(String, IDictionary<String,String>, IDictionary<String, String>, ResourceIdentifier, ResourceIdentifier, String, String, MachineLearningIdentityConfiguration, Nullable<Boolean>, NotificationSetting, IDictionary<String,SecretConfiguration>, IDictionary<String, MachineLearningJobService>, Nullable<MachineLearningJobStatus>, MachineLearningEarlyTerminationPolicy, IDictionary<String,MachineLearningJobInput>, MachineLearningSweepJobLimits, MachineLearningObjective, IDictionary<String, MachineLearningJobOutput>, JobQueueSettings, SamplingAlgorithm, BinaryData, MachineLearningTrialComponent)

Source:: ArmMachineLearningModelFactory.cs

Initializes a new instance of MachineLearningSweepJob.

public static Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJob MachineLearningSweepJob (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.MachineLearningEarlyTerminationPolicy earlyTermination = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobInput> inputs = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJobLimits limits = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningObjective objective = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> outputs = default, Azure.ResourceManager.MachineLearning.Models.JobQueueSettings queueSettings = default, Azure.ResourceManager.MachineLearning.Models.SamplingAlgorithm samplingAlgorithm = default, BinaryData searchSpace = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningTrialComponent trial = default);

static member MachineLearningSweepJob : 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> * Azure.ResourceManager.MachineLearning.Models.MachineLearningEarlyTerminationPolicy * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobInput> * Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJobLimits * Azure.ResourceManager.MachineLearning.Models.MachineLearningObjective * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobOutput> * Azure.ResourceManager.MachineLearning.Models.JobQueueSettings * Azure.ResourceManager.MachineLearning.Models.SamplingAlgorithm * BinaryData * Azure.ResourceManager.MachineLearning.Models.MachineLearningTrialComponent -> Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJob

Public Shared Function MachineLearningSweepJob (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 earlyTermination As MachineLearningEarlyTerminationPolicy = Nothing, Optional inputs As IDictionary(Of String, MachineLearningJobInput) = Nothing, Optional limits As MachineLearningSweepJobLimits = Nothing, Optional objective As MachineLearningObjective = Nothing, Optional outputs As IDictionary(Of String, MachineLearningJobOutput) = Nothing, Optional queueSettings As JobQueueSettings = Nothing, Optional samplingAlgorithm As SamplingAlgorithm = Nothing, Optional searchSpace As BinaryData = Nothing, Optional trial As MachineLearningTrialComponent = Nothing) As MachineLearningSweepJob