Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageModelSettings

Package version

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.

Hierarchy

  • ImageModelSettings

Index

Properties

Optional advancedSettings

advancedSettings: undefined | string

Settings for advanced scenarios.

Optional amsGradient

amsGradient: undefined | false | true

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

Optional augmentations

augmentations: undefined | string

Settings for using Augmentations.

Optional beta1

beta1: undefined | number

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

Optional beta2

beta2: undefined | number

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

Optional checkpointDatasetId

checkpointDatasetId: undefined | string

FileDataset id for pretrained checkpoint(s) for incremental training. Make sure to pass CheckpointFilename along with CheckpointDatasetId.

Optional checkpointFilename

checkpointFilename: undefined | string

The pretrained checkpoint filename in FileDataset for incremental training. Make sure to pass CheckpointDatasetId along with CheckpointFilename.

Optional checkpointFrequency

checkpointFrequency: undefined | number

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

Optional checkpointRunId

checkpointRunId: undefined | string

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

Optional distributed

distributed: undefined | false | true

Whether to use distributed training.

Optional earlyStopping

earlyStopping: undefined | false | true

Enable early stopping logic during training.

Optional earlyStoppingDelay

earlyStoppingDelay: undefined | number

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

Optional earlyStoppingPatience

earlyStoppingPatience: undefined | number

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

Optional enableOnnxNormalization

enableOnnxNormalization: undefined | false | true

Enable normalization when exporting ONNX model.

Optional evaluationFrequency

evaluationFrequency: undefined | number

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

Optional gradientAccumulationStep

gradientAccumulationStep: undefined | number

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.

Optional layersToFreeze

layersToFreeze: undefined | number

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.

Optional learningRate

learningRate: undefined | number

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

Optional learningRateScheduler

learningRateScheduler: LearningRateScheduler

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

Optional modelName

modelName: undefined | string

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.

Optional momentum

momentum: undefined | number

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

Optional nesterov

nesterov: undefined | false | true

Enable nesterov when optimizer is 'sgd'.

Optional numberOfEpochs

numberOfEpochs: undefined | number

Number of training epochs. Must be a positive integer.

Optional numberOfWorkers

numberOfWorkers: undefined | number

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

Optional optimizer

Type of optimizer.

Optional randomSeed

randomSeed: undefined | number

Random seed to be used when using deterministic training.

Optional splitRatio

splitRatio: undefined | number

If validation data is not defined, this specifies the split ratio for splitting train data into random train and validation subsets. Must be a float in the range [0, 1].

Optional stepLRGamma

stepLRGamma: undefined | number

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

Optional stepLRStepSize

stepLRStepSize: undefined | number

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

Optional trainingBatchSize

trainingBatchSize: undefined | number

Training batch size. Must be a positive integer.

Optional validationBatchSize

validationBatchSize: undefined | number

Validation batch size. Must be a positive integer.

Optional warmupCosineLRCycles

warmupCosineLRCycles: undefined | number

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

Optional warmupCosineLRWarmupEpochs

warmupCosineLRWarmupEpochs: undefined | number

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

Optional weightDecay

weightDecay: undefined | number

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

Generated using TypeDoc