Compartilhar via


SweepJob Class

Definition

Sweep job definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.SweepJobTypeConverter))]
public class SweepJob : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ISweepJob, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.SweepJobTypeConverter))>]
type SweepJob = class
    interface ISweepJob
    interface IJsonSerializable
    interface IJobBaseProperties
    interface IResourceBase
    interface IValidates
Public Class SweepJob
Implements ISweepJob, IValidates
Inheritance
SweepJob
Attributes
Implements

Constructors

SweepJob()

Creates an new SweepJob instance.

Properties

ComputeId

ARM resource ID of the compute resource.

Description

The asset description text.

DisplayName

Display name of job.

DistributionType

[Required] Specifies the type of distribution framework.

EarlyTerminationDelayEvaluation

Number of intervals by which to delay the first evaluation.

EarlyTerminationEvaluationInterval

Interval (number of runs) between policy evaluations.

EarlyTerminationPolicyType

[Required] Name of policy configuration

ExperimentName

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

Identity

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.

IdentityType

[Required] Specifies the type of identity framework.

Input

Mapping of input data bindings used in the job.

IsArchived

Is the asset archived?

JobType

[Required] Specifies the type of job.

LimitJobLimitsType

[Required] JobLimit type.

LimitMaxConcurrentTrial

Sweep Job max concurrent trials.

LimitMaxTotalTrial

Sweep Job max total trials.

LimitTimeout

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

LimitTrialTimeout

Sweep Job Trial timeout value.

ObjectiveGoal

[Required] Defines supported metric goals for hyperparameter tuning

ObjectivePrimaryMetric

[Required] Name of the metric to optimize.

Output

Mapping of output data bindings used in the job.

Property

The asset property dictionary.

ResourceInstanceCount

Optional number of instances or nodes used by the compute target.

ResourceInstanceType

Optional type of VM used as supported by the compute target.

ResourceProperty

Additional properties bag.

SamplingAlgorithmType

[Required] The algorithm used for generating hyperparameter values, along with configuration properties

SearchSpace

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

Service

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

Status

Status of the job.

Tag

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

TrialCodeId

ARM resource ID of the code asset.

TrialCommand

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

TrialEnvironmentId

[Required] The ARM resource ID of the Environment specification for the job.

TrialEnvironmentVariable

Environment variables included in the job.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SweepJob.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SweepJob.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.ISweepJob.

FromJsonString(String)

Creates a new instance of SweepJob, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of SweepJob into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to