NamedEntityRecognitionModelMetrics

class oci.ai_language.models.NamedEntityRecognitionModelMetrics(**kwargs)

Bases: object

Model level named entity recognition metrics

Methods:

__init__(**kwargs)

Initializes a new NamedEntityRecognitionModelMetrics object with values from keyword arguments.

Attributes:

macro_f1

[Required] Gets the macro_f1 of this NamedEntityRecognitionModelMetrics.

macro_precision

[Required] Gets the macro_precision of this NamedEntityRecognitionModelMetrics.

macro_recall

[Required] Gets the macro_recall of this NamedEntityRecognitionModelMetrics.

micro_f1

[Required] Gets the micro_f1 of this NamedEntityRecognitionModelMetrics.

micro_precision

[Required] Gets the micro_precision of this NamedEntityRecognitionModelMetrics.

micro_recall

[Required] Gets the micro_recall of this NamedEntityRecognitionModelMetrics.

weighted_f1

Gets the weighted_f1 of this NamedEntityRecognitionModelMetrics.

weighted_precision

Gets the weighted_precision of this NamedEntityRecognitionModelMetrics.

weighted_recall

Gets the weighted_recall of this NamedEntityRecognitionModelMetrics.

__init__(**kwargs)

Initializes a new NamedEntityRecognitionModelMetrics object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • micro_f1 (float) – The value to assign to the micro_f1 property of this NamedEntityRecognitionModelMetrics.

  • micro_precision (float) – The value to assign to the micro_precision property of this NamedEntityRecognitionModelMetrics.

  • micro_recall (float) – The value to assign to the micro_recall property of this NamedEntityRecognitionModelMetrics.

  • macro_f1 (float) – The value to assign to the macro_f1 property of this NamedEntityRecognitionModelMetrics.

  • macro_precision (float) – The value to assign to the macro_precision property of this NamedEntityRecognitionModelMetrics.

  • macro_recall (float) – The value to assign to the macro_recall property of this NamedEntityRecognitionModelMetrics.

  • weighted_f1 (float) – The value to assign to the weighted_f1 property of this NamedEntityRecognitionModelMetrics.

  • weighted_precision (float) – The value to assign to the weighted_precision property of this NamedEntityRecognitionModelMetrics.

  • weighted_recall (float) – The value to assign to the weighted_recall property of this NamedEntityRecognitionModelMetrics.

property macro_f1

[Required] Gets the macro_f1 of this NamedEntityRecognitionModelMetrics. F1-score, is a measure of a model’s accuracy on a dataset

Returns

The macro_f1 of this NamedEntityRecognitionModelMetrics.

Return type

float

property macro_precision

[Required] Gets the macro_precision of this NamedEntityRecognitionModelMetrics. Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)

Returns

The macro_precision of this NamedEntityRecognitionModelMetrics.

Return type

float

property macro_recall

[Required] Gets the macro_recall of this NamedEntityRecognitionModelMetrics. Measures the model’s ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.

Returns

The macro_recall of this NamedEntityRecognitionModelMetrics.

Return type

float

property micro_f1

[Required] Gets the micro_f1 of this NamedEntityRecognitionModelMetrics. F1-score, is a measure of a model’s accuracy on a dataset

Returns

The micro_f1 of this NamedEntityRecognitionModelMetrics.

Return type

float

property micro_precision

[Required] Gets the micro_precision of this NamedEntityRecognitionModelMetrics. Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)

Returns

The micro_precision of this NamedEntityRecognitionModelMetrics.

Return type

float

property micro_recall

[Required] Gets the micro_recall of this NamedEntityRecognitionModelMetrics. Measures the model’s ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.

Returns

The micro_recall of this NamedEntityRecognitionModelMetrics.

Return type

float

property weighted_f1

Gets the weighted_f1 of this NamedEntityRecognitionModelMetrics. F1-score, is a measure of a model’s accuracy on a dataset

Returns

The weighted_f1 of this NamedEntityRecognitionModelMetrics.

Return type

float

property weighted_precision

Gets the weighted_precision of this NamedEntityRecognitionModelMetrics. Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)

Returns

The weighted_precision of this NamedEntityRecognitionModelMetrics.

Return type

float

property weighted_recall

Gets the weighted_recall of this NamedEntityRecognitionModelMetrics. Measures the model’s ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.

Returns

The weighted_recall of this NamedEntityRecognitionModelMetrics.

Return type

float