TextClassification Class

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

public final class TextClassification
extends AutoMLVertical

Text Classification task in AutoML NLP vertical. NLP - Natural Language Processing.

Constructor Summary

Constructor Description
TextClassification()

Creates an instance of TextClassification class.

Method Summary

Modifier and Type Method and Description
NlpVerticalFeaturizationSettings featurizationSettings()

Get the featurizationSettings property: Featurization inputs needed for AutoML job.
static TextClassification fromJson(JsonReader jsonReader)

Reads an instance of TextClassification from the JsonReader.
NlpVerticalLimitSettings limitSettings()

Get the limitSettings property: Execution constraints for AutoMLJob.
ClassificationPrimaryMetrics primaryMetric()

Get the primaryMetric property: Primary metric for Text-Classification task.
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.
TextClassification withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)

Set the featurizationSettings property: Featurization inputs needed for AutoML job.
TextClassification withLimitSettings(NlpVerticalLimitSettings limitSettings)

Set the limitSettings property: Execution constraints for AutoMLJob.
TextClassification withLogVerbosity(LogVerbosity logVerbosity)

Set the logVerbosity property: Log verbosity for the job.
TextClassification withPrimaryMetric(ClassificationPrimaryMetrics primaryMetric)

Set the primaryMetric property: Primary metric for Text-Classification task.
TextClassification withTargetColumnName(String targetColumnName)

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

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

Set the validationData property: Validation data inputs.

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

TextClassification

public TextClassification()

Creates an instance of TextClassification class.

Method Details

featurizationSettings

public NlpVerticalFeaturizationSettings featurizationSettings()

Get the featurizationSettings property: Featurization inputs needed for AutoML job.

Returns:

the featurizationSettings value.

fromJson

public static TextClassification fromJson(JsonReader jsonReader)

Reads an instance of TextClassification from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TextClassification 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 NlpVerticalLimitSettings limitSettings()

Get the limitSettings property: Execution constraints for AutoMLJob.

Returns:

the limitSettings value.

primaryMetric

public ClassificationPrimaryMetrics primaryMetric()

Get the primaryMetric property: Primary metric for Text-Classification task.

Returns:

the primaryMetric value.

taskType

public TaskType taskType()

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

Overrides:

TextClassification.taskType()

Returns:

the taskType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

TextClassification.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

TextClassification.validate()

validationData

public MLTableJobInput validationData()

Get the validationData property: Validation data inputs.

Returns:

the validationData value.

withFeaturizationSettings

public TextClassification withFeaturizationSettings(NlpVerticalFeaturizationSettings featurizationSettings)

Set the featurizationSettings property: Featurization inputs needed for AutoML job.

Parameters:

featurizationSettings - the featurizationSettings value to set.

Returns:

the TextClassification object itself.

withLimitSettings

public TextClassification withLimitSettings(NlpVerticalLimitSettings limitSettings)

Set the limitSettings property: Execution constraints for AutoMLJob.

Parameters:

limitSettings - the limitSettings value to set.

Returns:

the TextClassification object itself.

withLogVerbosity

public TextClassification withLogVerbosity(LogVerbosity logVerbosity)

Set the logVerbosity property: Log verbosity for the job.

Overrides:

TextClassification.withLogVerbosity(LogVerbosity logVerbosity)

Parameters:

logVerbosity

withPrimaryMetric

public TextClassification withPrimaryMetric(ClassificationPrimaryMetrics primaryMetric)

Set the primaryMetric property: Primary metric for Text-Classification task.

Parameters:

primaryMetric - the primaryMetric value to set.

Returns:

the TextClassification object itself.

withTargetColumnName

public TextClassification 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:

TextClassification.withTargetColumnName(String targetColumnName)

Parameters:

targetColumnName

withTrainingData

public TextClassification withTrainingData(MLTableJobInput trainingData)

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

Overrides:

TextClassification.withTrainingData(MLTableJobInput trainingData)

Parameters:

trainingData

withValidationData

public TextClassification withValidationData(MLTableJobInput validationData)

Set the validationData property: Validation data inputs.

Parameters:

validationData - the validationData value to set.

Returns:

the TextClassification object itself.

Applies to