MachineLearningSweepJob Class

Definition

Namespace:

Azure.ResourceManager.MachineLearning.Models

Assembly:

Azure.ResourceManager.MachineLearning.dll

Package:

Azure.ResourceManager.MachineLearning v1.2.1

Source:

MachineLearningSweepJob.cs

Sweep job definition.

public class MachineLearningSweepJob : Azure.ResourceManager.MachineLearning.Models.MachineLearningJobProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJob>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.MachineLearning.Models.MachineLearningSweepJob>

type MachineLearningSweepJob = class
    inherit MachineLearningJobProperties
    interface IJsonModel<MachineLearningSweepJob>
    interface IPersistableModel<MachineLearningSweepJob>

Public Class MachineLearningSweepJob
Inherits MachineLearningJobProperties
Implements IJsonModel(Of MachineLearningSweepJob), IPersistableModel(Of MachineLearningSweepJob)

Inheritance

Object

MachineLearningResourceBase

MachineLearningJobProperties

MachineLearningSweepJob

Implements

IJsonModel<MachineLearningSweepJob> IPersistableModel<MachineLearningSweepJob> IPersistableModel<T>

Constructors

MachineLearningSweepJob(BinaryData, SamplingAlgorithm, MachineLearningObjective, MachineLearningTrialComponent)	Initializes a new instance of MachineLearningSweepJob.
MachineLearningSweepJob(MachineLearningObjective, SamplingAlgorithm, BinaryData, MachineLearningTrialComponent)	Initializes a new instance of MachineLearningSweepJob.

Properties

ComponentId	ARM resource ID of the component resource. (Inherited from MachineLearningJobProperties)
ComputeId	ARM resource ID of the compute resource. (Inherited from MachineLearningJobProperties)
Description	The asset description text. (Inherited from MachineLearningResourceBase)
DisplayName	Display name of job. (Inherited from MachineLearningJobProperties)
EarlyTermination	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.
ExperimentName	The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. (Inherited from MachineLearningJobProperties)
Identity	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. (Inherited from MachineLearningJobProperties)
Inputs	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.
IsArchived	Is the asset archived?. (Inherited from MachineLearningJobProperties)
Limits	Sweep Job limit.
NotificationSetting	Notification setting for the job. (Inherited from MachineLearningJobProperties)
Objective	[Required] Optimization objective.
Outputs	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.
Properties	The asset property dictionary. (Inherited from MachineLearningResourceBase)
QueueJobTier	Controls the compute job tier.
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	[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
SecretsConfiguration	Configuration for secrets to be made available during runtime. (Inherited from MachineLearningJobProperties)
Services	List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. (Inherited from MachineLearningJobProperties)
Status	Status of the job. (Inherited from MachineLearningJobProperties)
Tags	Tag dictionary. Tags can be added, removed, and updated. (Inherited from MachineLearningResourceBase)
Trial	[Required] Trial component definition.

Explicit Interface Implementations

IJsonModel<MachineLearningJobProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from MachineLearningJobProperties)
IJsonModel<MachineLearningJobProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from MachineLearningJobProperties)
IJsonModel<MachineLearningResourceBase>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from MachineLearningResourceBase)
IJsonModel<MachineLearningResourceBase>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from MachineLearningResourceBase)
IJsonModel<MachineLearningSweepJob>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<MachineLearningSweepJob>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<MachineLearningJobProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from MachineLearningJobProperties)
IPersistableModel<MachineLearningJobProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from MachineLearningJobProperties)
IPersistableModel<MachineLearningJobProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from MachineLearningJobProperties)
IPersistableModel<MachineLearningResourceBase>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from MachineLearningResourceBase)
IPersistableModel<MachineLearningResourceBase>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from MachineLearningResourceBase)
IPersistableModel<MachineLearningResourceBase>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from MachineLearningResourceBase)
IPersistableModel<MachineLearningSweepJob>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<MachineLearningSweepJob>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<MachineLearningSweepJob>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.