Share via

SweepJob interface

Package:
@azure/arm-machinelearning

Sweep job definition.

Extends
JobBaseProperties

Properties

earlyTermination

Early termination policies enable canceling poor-performing runs before they complete
inputs

Mapping of input data bindings used in the job.
jobType

Polymorphic discriminator, which specifies the different types this object can be
limits

Sweep Job limit.
objective

[Required] Optimization objective.
outputs

Mapping of output data bindings used in the job.
queueSettings

Queue settings for the job
samplingAlgorithm

[Required] The hyperparameter sampling algorithm
searchSpace

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

[Required] Trial component definition.

Inherited Properties

componentId

ARM resource ID of the component resource.
computeId

ARM resource ID of the compute resource.
description

The asset description text.
displayName

Display name of job.
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.
isArchived

Is the asset archived?
notificationSetting

Notification setting for the job
properties

The asset property dictionary.
services

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

Status of the job. NOTE: This property will not be serialized. It can only be populated by the server.
tags

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

Property Details

earlyTermination

Early termination policies enable canceling poor-performing runs before they complete

earlyTermination?: EarlyTerminationPolicyUnion

Property Value

EarlyTerminationPolicyUnion

inputs

Mapping of input data bindings used in the job.

inputs?: {[propertyName: string]: JobInputUnion | null}

Property Value

{[propertyName: string]: JobInputUnion | null}

jobType

Polymorphic discriminator, which specifies the different types this object can be

jobType: "Sweep"

Property Value

"Sweep"

limits

Sweep Job limit.

limits?: SweepJobLimits

Property Value

SweepJobLimits

objective

[Required] Optimization objective.

objective: Objective

Property Value

Objective

outputs

Mapping of output data bindings used in the job.

outputs?: {[propertyName: string]: JobOutputUnion | null}

Property Value

{[propertyName: string]: JobOutputUnion | null}

queueSettings

Queue settings for the job

queueSettings?: QueueSettings

Property Value

QueueSettings

samplingAlgorithm

[Required] The hyperparameter sampling algorithm

samplingAlgorithm: SamplingAlgorithmUnion

Property Value

SamplingAlgorithmUnion

searchSpace

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

searchSpace: Record<string, unknown>

Property Value

Record<string, unknown>

trial

[Required] Trial component definition.

trial: TrialComponent

Property Value

TrialComponent

Inherited Property Details

componentId

ARM resource ID of the component resource.

componentId?: string

Property Value

string

Inherited From JobBaseProperties.componentId

computeId

ARM resource ID of the compute resource.

computeId?: string

Property Value

string

Inherited From JobBaseProperties.computeId

description

The asset description text.

description?: string

Property Value

string

Inherited From JobBaseProperties.description

displayName

Display name of job.

displayName?: string

Property Value

string

Inherited From JobBaseProperties.displayName

experimentName

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

experimentName?: string

Property Value

string

Inherited From JobBaseProperties.experimentName

identity

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

identity?: IdentityConfigurationUnion

Property Value

IdentityConfigurationUnion

Inherited From JobBaseProperties.identity

isArchived

Is the asset archived?

isArchived?: boolean

Property Value

boolean

Inherited From JobBaseProperties.isArchived

notificationSetting

Notification setting for the job

notificationSetting?: NotificationSetting

Property Value

NotificationSetting

Inherited From JobBaseProperties.notificationSetting

properties

The asset property dictionary.

properties?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From JobBaseProperties.properties

services

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

services?: {[propertyName: string]: JobService | null}

Property Value

{[propertyName: string]: JobService | null}

Inherited From JobBaseProperties.services

status

Status of the job. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

Inherited From JobBaseProperties.status

tags

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

tags?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From JobBaseProperties.tags