SweepJobResponse

data class SweepJobResponse(val algorithm: String, val compute: ComputeConfigurationResponse, val description: String? = null, val earlyTermination: Any? = null, val experimentName: String? = null, val identity: Either<AmlTokenResponse, ManagedIdentityResponse>? = null, val interactionEndpoints: Map<String, JobEndpointResponse>, val jobType: String, val maxConcurrentTrials: Int? = null, val maxTotalTrials: Int? = null, val objective: ObjectiveResponse, val output: JobOutputResponse, val priority: Int? = null, val properties: Map<String, String>? = null, val provisioningState: String, val searchSpace: Map<String, Any>, val status: String, val tags: Map<String, String>? = null, val timeout: String? = null, val trial: TrialComponentResponse? = null)

Sweep job definition.

Constructors

Link copied to clipboard
constructor(algorithm: String, compute: ComputeConfigurationResponse, description: String? = null, earlyTermination: Any? = null, experimentName: String? = null, identity: Either<AmlTokenResponse, ManagedIdentityResponse>? = null, interactionEndpoints: Map<String, JobEndpointResponse>, jobType: String, maxConcurrentTrials: Int? = null, maxTotalTrials: Int? = null, objective: ObjectiveResponse, output: JobOutputResponse, priority: Int? = null, properties: Map<String, String>? = null, provisioningState: String, searchSpace: Map<String, Any>, status: String, tags: Map<String, String>? = null, timeout: String? = null, trial: TrialComponentResponse? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Required Type of the hyperparameter sampling algorithms

Link copied to clipboard

Required Compute binding for the job.

Link copied to clipboard
val description: String? = null

The asset description text.

Link copied to clipboard
val earlyTermination: Any? = null

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

Link copied to clipboard
val experimentName: 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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val maxTotalTrials: Int? = null

An upper bound on the number of trials to perform.

Link copied to clipboard

Required Optimization objective.

Link copied to clipboard

Location of the job output logs and artifacts.

Link copied to clipboard
val priority: 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: Map<String, String>? = null

The asset property dictionary.

Link copied to clipboard

Specifies the job provisioning state.

Link copied to clipboard

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

Link copied to clipboard

The status of a job.

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

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

Link copied to clipboard
val timeout: String? = null

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

Link copied to clipboard

Trial component definition.