ImageObjectDetection Class

Package:
com.azure.resourcemanager.machinelearning.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0

public final class ImageObjectDetection
extends AutoMLVertical

Image Object Detection. Object detection is used to identify objects in an image and locate each object with a bounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.

Constructor Summary

Constructor Description
ImageObjectDetection()

Creates an instance of ImageObjectDetection class.

Method Summary

Modifier and Type Method and Description
static ImageObjectDetection fromJson(JsonReader jsonReader)

Reads an instance of ImageObjectDetection from the JsonReader.
ImageLimitSettings limitSettings()

Get the limitSettings property: [Required] Limit settings for the AutoML job.
ImageModelSettingsObjectDetection modelSettings()

Get the modelSettings property: Settings used for training the model.
ObjectDetectionPrimaryMetrics primaryMetric()

Get the primaryMetric property: Primary metric to optimize for this task.
List<ImageModelDistributionSettingsObjectDetection> searchSpace()

Get the searchSpace property: Search space for sampling different combinations of models and their hyperparameters.
ImageSweepSettings sweepSettings()

Get the sweepSettings property: Model sweeping and hyperparameter sweeping related settings.
TaskType taskType()

Get the taskType property: [Required] Task type for AutoMLJob.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
MLTableJobInput validationData()

Get the validationData property: Validation data inputs.
Double validationDataSize()

Get the validationDataSize property: The fraction of training dataset that needs to be set aside for validation purpose.
ImageObjectDetection withLimitSettings(ImageLimitSettings limitSettings)

Set the limitSettings property: [Required] Limit settings for the AutoML job.
ImageObjectDetection withLogVerbosity(LogVerbosity logVerbosity)

Set the logVerbosity property: Log verbosity for the job.
ImageObjectDetection withModelSettings(ImageModelSettingsObjectDetection modelSettings)

Set the modelSettings property: Settings used for training the model.
ImageObjectDetection withPrimaryMetric(ObjectDetectionPrimaryMetrics primaryMetric)

Set the primaryMetric property: Primary metric to optimize for this task.
ImageObjectDetection withSearchSpace(List<ImageModelDistributionSettingsObjectDetection> searchSpace)

Set the searchSpace property: Search space for sampling different combinations of models and their hyperparameters.
ImageObjectDetection withSweepSettings(ImageSweepSettings sweepSettings)

Set the sweepSettings property: Model sweeping and hyperparameter sweeping related settings.
ImageObjectDetection withTargetColumnName(String targetColumnName)

Set the targetColumnName property: Target column name: This is prediction values column.
ImageObjectDetection withTrainingData(MLTableJobInput trainingData)

Set the trainingData property: [Required] Training data input.
ImageObjectDetection withValidationData(MLTableJobInput validationData)

Set the validationData property: Validation data inputs.
ImageObjectDetection withValidationDataSize(Double validationDataSize)

Set the validationDataSize property: The fraction of training dataset that needs to be set aside for validation purpose.

Methods inherited from AutoMLVertical

fromJson logVerbosity targetColumnName taskType toJson trainingData validate withLogVerbosity withTargetColumnName withTrainingData

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ImageObjectDetection

public ImageObjectDetection()

Creates an instance of ImageObjectDetection class.

Method Details

fromJson

public static ImageObjectDetection fromJson(JsonReader jsonReader)

Reads an instance of ImageObjectDetection from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ImageObjectDetection if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

limitSettings

public ImageLimitSettings limitSettings()

Get the limitSettings property: [Required] Limit settings for the AutoML job.

Returns:

the limitSettings value.

modelSettings

public ImageModelSettingsObjectDetection modelSettings()

Get the modelSettings property: Settings used for training the model.

Returns:

the modelSettings value.

primaryMetric

public ObjectDetectionPrimaryMetrics primaryMetric()

Get the primaryMetric property: Primary metric to optimize for this task.

Returns:

the primaryMetric value.

searchSpace

public List<ImageModelDistributionSettingsObjectDetection> searchSpace()

Get the searchSpace property: Search space for sampling different combinations of models and their hyperparameters.

Returns:

the searchSpace value.

sweepSettings

public ImageSweepSettings sweepSettings()

Get the sweepSettings property: Model sweeping and hyperparameter sweeping related settings.

Returns:

the sweepSettings value.

taskType

public TaskType taskType()

Get the taskType property: [Required] Task type for AutoMLJob.

Overrides:

ImageObjectDetection.taskType()

Returns:

the taskType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ImageObjectDetection.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

ImageObjectDetection.validate()

validationData

public MLTableJobInput validationData()

Get the validationData property: Validation data inputs.

Returns:

the validationData value.

validationDataSize

public Double validationDataSize()

Get the validationDataSize property: The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied when validation dataset is not provided.

Returns:

the validationDataSize value.

withLimitSettings

public ImageObjectDetection withLimitSettings(ImageLimitSettings limitSettings)

Set the limitSettings property: [Required] Limit settings for the AutoML job.

Parameters:

limitSettings - the limitSettings value to set.

Returns:

the ImageObjectDetection object itself.

withLogVerbosity

public ImageObjectDetection withLogVerbosity(LogVerbosity logVerbosity)

Set the logVerbosity property: Log verbosity for the job.

Overrides:

ImageObjectDetection.withLogVerbosity(LogVerbosity logVerbosity)

Parameters:

logVerbosity

withModelSettings

public ImageObjectDetection withModelSettings(ImageModelSettingsObjectDetection modelSettings)

Set the modelSettings property: Settings used for training the model.

Parameters:

modelSettings - the modelSettings value to set.

Returns:

the ImageObjectDetection object itself.

withPrimaryMetric

public ImageObjectDetection withPrimaryMetric(ObjectDetectionPrimaryMetrics primaryMetric)

Set the primaryMetric property: Primary metric to optimize for this task.

Parameters:

primaryMetric - the primaryMetric value to set.

Returns:

the ImageObjectDetection object itself.

withSearchSpace

public ImageObjectDetection withSearchSpace(List<ImageModelDistributionSettingsObjectDetection> searchSpace)

Set the searchSpace property: Search space for sampling different combinations of models and their hyperparameters.

Parameters:

searchSpace - the searchSpace value to set.

Returns:

the ImageObjectDetection object itself.

withSweepSettings

public ImageObjectDetection withSweepSettings(ImageSweepSettings sweepSettings)

Set the sweepSettings property: Model sweeping and hyperparameter sweeping related settings.

Parameters:

sweepSettings - the sweepSettings value to set.

Returns:

the ImageObjectDetection object itself.

withTargetColumnName

public ImageObjectDetection withTargetColumnName(String targetColumnName)

Set the targetColumnName property: Target column name: This is prediction values column. Also known as label column name in context of classification tasks.

Overrides:

ImageObjectDetection.withTargetColumnName(String targetColumnName)

Parameters:

targetColumnName

withTrainingData

public ImageObjectDetection withTrainingData(MLTableJobInput trainingData)

Set the trainingData property: [Required] Training data input.

Overrides:

ImageObjectDetection.withTrainingData(MLTableJobInput trainingData)

Parameters:

trainingData

withValidationData

public ImageObjectDetection withValidationData(MLTableJobInput validationData)

Set the validationData property: Validation data inputs.

Parameters:

validationData - the validationData value to set.

Returns:

the ImageObjectDetection object itself.

withValidationDataSize

public ImageObjectDetection withValidationDataSize(Double validationDataSize)

Set the validationDataSize property: The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied when validation dataset is not provided.

Parameters:

validationDataSize - the validationDataSize value to set.

Returns:

the ImageObjectDetection object itself.

Applies to