ImageModelSettings interface

Package:

@azure/arm-machinelearning

Settings used for training the model. For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

Properties

advancedSettings	Settings for advanced scenarios.
amsGradient	Enable AMSGrad when optimizer is 'adam' or 'adamw'.
augmentations	Settings for using Augmentations.
beta1	Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
beta2	Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
checkpointFrequency	Frequency to store model checkpoints. Must be a positive integer.
checkpointModel	The pretrained checkpoint model for incremental training.
checkpointRunId	The id of a previous run that has a pretrained checkpoint for incremental training.
distributed	Whether to use distributed training.
earlyStopping	Enable early stopping logic during training.
earlyStoppingDelay	Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping. Must be a positive integer.
earlyStoppingPatience	Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be a positive integer.
enableOnnxNormalization	Enable normalization when exporting ONNX model.
evaluationFrequency	Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
gradientAccumulationStep	Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights while accumulating the gradients of those steps, and then using the accumulated gradients to compute the weight updates. Must be a positive integer.
layersToFreeze	Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext' means freezing layer0 and layer1. For a full list of models supported and details on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
learningRate	Initial learning rate. Must be a float in the range [0, 1].
learningRateScheduler	Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
modelName	Name of the model to use for training. For more information on the available models please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
momentum	Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
nesterov	Enable nesterov when optimizer is 'sgd'.
numberOfEpochs	Number of training epochs. Must be a positive integer.
numberOfWorkers	Number of data loader workers. Must be a non-negative integer.
optimizer	Type of optimizer.
randomSeed	Random seed to be used when using deterministic training.
stepLRGamma	Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
stepLRStepSize	Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
trainingBatchSize	Training batch size. Must be a positive integer.
validationBatchSize	Validation batch size. Must be a positive integer.
warmupCosineLRCycles	Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
warmupCosineLRWarmupEpochs	Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
weightDecay	Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].

Property Details

advancedSettings

Settings for advanced scenarios.

advancedSettings?: string

Property Value

string

amsGradient

Enable AMSGrad when optimizer is 'adam' or 'adamw'.

amsGradient?: boolean

Property Value

boolean

augmentations

Settings for using Augmentations.

augmentations?: string

Property Value

string

beta1

Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].

beta1?: number

Property Value

number

beta2

Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].

beta2?: number

Property Value

number

checkpointFrequency

Frequency to store model checkpoints. Must be a positive integer.

checkpointFrequency?: number

Property Value

number

checkpointModel

The pretrained checkpoint model for incremental training.

checkpointModel?: MLFlowModelJobInput

Property Value

MLFlowModelJobInput

checkpointRunId

The id of a previous run that has a pretrained checkpoint for incremental training.

checkpointRunId?: string

Property Value

string

distributed

Whether to use distributed training.

distributed?: boolean

Property Value

boolean

earlyStopping

Enable early stopping logic during training.

earlyStopping?: boolean

Property Value

boolean

earlyStoppingDelay

Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping. Must be a positive integer.

earlyStoppingDelay?: number

Property Value

number

earlyStoppingPatience

Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be a positive integer.

earlyStoppingPatience?: number

Property Value

number

enableOnnxNormalization

Enable normalization when exporting ONNX model.

enableOnnxNormalization?: boolean

Property Value

boolean

evaluationFrequency

Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.

evaluationFrequency?: number

Property Value

number

gradientAccumulationStep

Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights while accumulating the gradients of those steps, and then using the accumulated gradients to compute the weight updates. Must be a positive integer.

gradientAccumulationStep?: number

Property Value

number

layersToFreeze

Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext' means freezing layer0 and layer1. For a full list of models supported and details on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

layersToFreeze?: number

Property Value

number

learningRate

Initial learning rate. Must be a float in the range [0, 1].

learningRate?: number

Property Value

number

learningRateScheduler

Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.

learningRateScheduler?: string

Property Value

string

modelName

Name of the model to use for training. For more information on the available models please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

modelName?: string

Property Value

string

momentum

Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].

momentum?: number

Property Value

number

nesterov

Enable nesterov when optimizer is 'sgd'.

nesterov?: boolean

Property Value

boolean

numberOfEpochs

Number of training epochs. Must be a positive integer.

numberOfEpochs?: number

Property Value

number

numberOfWorkers

Number of data loader workers. Must be a non-negative integer.

numberOfWorkers?: number

Property Value

number

optimizer

Type of optimizer.

optimizer?: string

Property Value

string

randomSeed

Random seed to be used when using deterministic training.

randomSeed?: number

Property Value

number

stepLRGamma

Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].

stepLRGamma?: number

Property Value

number

stepLRStepSize

Value of step size when learning rate scheduler is 'step'. Must be a positive integer.

stepLRStepSize?: number

Property Value

number

trainingBatchSize

Training batch size. Must be a positive integer.

trainingBatchSize?: number

Property Value

number

validationBatchSize

Validation batch size. Must be a positive integer.

validationBatchSize?: number

Property Value

number

warmupCosineLRCycles

Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].

warmupCosineLRCycles?: number

Property Value

number

warmupCosineLRWarmupEpochs

Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.

warmupCosineLRWarmupEpochs?: number

Property Value

number

weightDecay

Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].

weightDecay?: number

Property Value

number