ArmMachineLearningModelFactory.MachineLearningSweepJob Method

Definition

Namespace:

Azure.ResourceManager.MachineLearning.Models

Assembly:

Azure.ResourceManager.MachineLearning.dll

Package:

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

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

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.

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.

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.

limits

MachineLearningSweepJobLimits

Sweep Job limit.

objective

MachineLearningObjective

[Required] Optimization objective.

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.

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.

searchSpace

BinaryData

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

trial

MachineLearningTrialComponent

[Required] Trial component definition.

Returns

MachineLearningSweepJob

A new MachineLearningSweepJob instance for mocking.