SweepJobArgs

data class SweepJobArgs(val algorithm: Output<Either<String, SamplingAlgorithm>>, val compute: Output<ComputeConfigurationArgs>, val description: Output<String>? = null, val earlyTermination: Output<Any>? = null, val experimentName: Output<String>? = null, val identity: Output<Either<AmlTokenArgs, ManagedIdentityArgs>>? = null, val jobType: Output<String>, val maxConcurrentTrials: Output<Int>? = null, val maxTotalTrials: Output<Int>? = null, val objective: Output<ObjectiveArgs>, val priority: Output<Int>? = null, val properties: Output<Map<String, String>>? = null, val searchSpace: Output<Map<String, Any>>, val tags: Output<Map<String, String>>? = null, val timeout: Output<String>? = null, val trial: Output<TrialComponentArgs>? = null) : ConvertibleToJava<SweepJobArgs>

Sweep job definition.

Constructors

Link copied to clipboard
constructor(algorithm: Output<Either<String, SamplingAlgorithm>>, compute: Output<ComputeConfigurationArgs>, description: Output<String>? = null, earlyTermination: Output<Any>? = null, experimentName: Output<String>? = null, identity: Output<Either<AmlTokenArgs, ManagedIdentityArgs>>? = null, jobType: Output<String>, maxConcurrentTrials: Output<Int>? = null, maxTotalTrials: Output<Int>? = null, objective: Output<ObjectiveArgs>, priority: Output<Int>? = null, properties: Output<Map<String, String>>? = null, searchSpace: Output<Map<String, Any>>, tags: Output<Map<String, String>>? = null, timeout: Output<String>? = null, trial: Output<TrialComponentArgs>? = null)

Properties

Link copied to clipboard
val algorithm: Output<Either<String, SamplingAlgorithm>>

Required Type of the hyperparameter sampling algorithms

Link copied to clipboard

Required Compute binding for the job.

Link copied to clipboard
val description: Output<String>? = null

The asset description text.

Link copied to clipboard
val earlyTermination: Output<Any>? = null

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

Link copied to clipboard
val experimentName: Output<String>? = null

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

Link copied to clipboard
val identity: Output<Either<AmlTokenArgs, ManagedIdentityArgs>>? = null

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

Link copied to clipboard
val jobType: Output<String>

Enum to determine the type of job. Expected value is 'Sweep'.

Link copied to clipboard
val maxConcurrentTrials: Output<Int>? = null

An upper bound on the number of trials performed in parallel.

Link copied to clipboard
val maxTotalTrials: Output<Int>? = null

An upper bound on the number of trials to perform.

Link copied to clipboard

Required Optimization objective.

Link copied to clipboard
val priority: Output<Int>? = null

Job priority for scheduling policy. Only applies to AMLCompute. Private preview feature and only available to users on the allow list.

Link copied to clipboard
val properties: Output<Map<String, String>>? = null

The asset property dictionary.

Link copied to clipboard
val searchSpace: Output<Map<String, Any>>

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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

Link copied to clipboard
val timeout: Output<String>? = null

The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.

Link copied to clipboard
val trial: Output<TrialComponentArgs>? = null

Trial component definition.

Functions

Link copied to clipboard
open override fun toJava(): SweepJobArgs