New-AzMLWorkspaceSweepJobObject

Create an in-memory object for SweepJob.

Syntax

New-AzMLWorkspaceSweepJobObject
   -ObjectiveGoal <Goal>
   -ObjectivePrimaryMetric <String>
   -SamplingAlgorithmType <SamplingAlgorithmType>
   -SearchSpace <IAny>
   -TrialCommand <String>
   -TrialEnvironmentId <String>
   [-DistributionType <DistributionType>]
   [-EarlyTerminationDelayEvaluation <Int32>]
   [-EarlyTerminationEvaluationInterval <Int32>]
   [-EarlyTerminationPolicyType <EarlyTerminationPolicyType>]
   [-JobInput <ISweepJobInputs>]
   [-LimitMaxConcurrentTrial <Int32>]
   [-LimitMaxTotalTrial <Int32>]
   [-LimitTimeout <TimeSpan>]
   [-LimitTrialTimeout <TimeSpan>]
   [-JobOutput <ISweepJobOutputs>]
   [-ResourceInstanceCount <Int32>]
   [-ResourceInstanceType <String>]
   [-ResourceProperty <IResourceConfigurationProperties>]
   [-TrialCodeId <String>]
   [-TrialEnvironmentVariable <ITrialComponentEnvironmentVariables>]
   [-ComputeId <String>]
   [-DisplayName <String>]
   [-ExperimentName <String>]
   [-IdentityType <IdentityConfigurationType>]
   [-IsArchived <Boolean>]
   [-ServiceEndpoint <String>]
   [-ServicePort <Int32>]
   [-ServiceProperty <IJobServiceProperties>]
   [-ServiceType <String>]
   [-Description <String>]
   [-Property <IResourceBaseProperties>]
   [-Tag <IResourceBaseTags>]
   [<CommonParameters>]

Description

Create an in-memory object for SweepJob.

Examples

Example 1: Create an in-memory object for SweepJob

# You can use following commands to create job input or job output as value pass to JobInput or JobOutput parameter of the New-AzMLWorkspaceSweepJobObject

# New-AzMLWorkspaceCustomModelJobInputObject
# New-AzMLWorkspaceCustomModelJobOutputObject
# New-AzMLWorkspaceLiteralJobInputObject
# New-AzMLWorkspaceMLFlowModelJobInputObject
# New-AzMLWorkspaceMLFlowModelJobOutputObject
# New-AzMLWorkspaceMLTableJobInputObject
# New-AzMLWorkspaceMLTableJobOutputObject
# New-AzMLWorkspaceSharedPrivateLinkResourceObject
# New-AzMLWorkspaceTritonModelJobInputObject
# New-AzMLWorkspaceTritonModelJobOutputObject
# New-AzMLWorkspaceUriFileJobInputObject
# New-AzMLWorkspaceUriFileJobOutputObject
# New-AzMLWorkspaceUriFolderJobInputObject
# New-AzMLWorkspaceUriFolderJobOutputObject

New-AzMLWorkspaceSweepJobObject

Create an in-memory object for SweepJob

Parameters

-ComputeId

ARM resource ID of the compute resource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

The asset description text.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

Display name of job.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DistributionType

[Required] Specifies the type of distribution framework.

Type:DistributionType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EarlyTerminationDelayEvaluation

Number of intervals by which to delay the first evaluation.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EarlyTerminationEvaluationInterval

Interval (number of runs) between policy evaluations.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EarlyTerminationPolicyType

[Required] Name of policy configuration.

Type:EarlyTerminationPolicyType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExperimentName

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

[Required] Specifies the type of identity framework.

Type:IdentityConfigurationType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsArchived

Is the asset archived?.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobInput

Mapping of input data bindings used in the job. To construct, see NOTES section for JOBINPUT properties and create a hash table.

Type:ISweepJobInputs
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobOutput

Mapping of output data bindings used in the job. To construct, see NOTES section for JOBOUTPUT properties and create a hash table.

Type:ISweepJobOutputs
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LimitMaxConcurrentTrial

Sweep Job max concurrent trials.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LimitMaxTotalTrial

Sweep Job max total trials.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LimitTrialTimeout

Sweep Job Trial timeout value.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ObjectiveGoal

[Required] Defines supported metric goals for hyperparameter tuning.

Type:Goal
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ObjectivePrimaryMetric

[Required] Name of the metric to optimize.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Property

The asset property dictionary. To construct, see NOTES section for PROPERTY properties and create a hash table.

Type:IResourceBaseProperties
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceInstanceCount

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceInstanceType

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceProperty

Additional properties bag. To construct, see NOTES section for RESOURCEPROPERTY properties and create a hash table.

Type:IResourceConfigurationProperties
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SamplingAlgorithmType

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

Type:SamplingAlgorithmType
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SearchSpace

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

Type:IAny
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ServiceEndpoint

Url for endpoint.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServicePort

Port for endpoint.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServiceProperty

Additional properties to set on the endpoint. To construct, see NOTES section for SERVICEPROPERTY properties and create a hash table.

Type:IJobServiceProperties
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServiceType

Endpoint type.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Tag dictionary. Tags can be added, removed, and updated. To construct, see NOTES section for TAG properties and create a hash table.

Type:IResourceBaseTags
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrialCodeId

ARM resource ID of the code asset.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrialCommand

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TrialEnvironmentId

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TrialEnvironmentVariable

Environment variables included in the job. To construct, see NOTES section for TRIALENVIRONMENTVARIABLE properties and create a hash table.

Type:ITrialComponentEnvironmentVariables
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

SweepJob