ModelMetrics

class oci.ai_document.models.ModelMetrics(**kwargs)

Bases: object

Trained Model Metrics.

Attributes:

MODEL_TYPE_DOCUMENT_CLASSIFICATION	A constant which can be used with the model_type property of a ModelMetrics.
MODEL_TYPE_KEY_VALUE_EXTRACTION	A constant which can be used with the model_type property of a ModelMetrics.
MODEL_TYPE_PRE_TRAINED_DOCUMENT_CLASSIFICATION	A constant which can be used with the model_type property of a ModelMetrics.
MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION	A constant which can be used with the model_type property of a ModelMetrics.
MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION	A constant which can be used with the model_type property of a ModelMetrics.
MODEL_TYPE_PRE_TRAINED_TABLE_EXTRACTION	A constant which can be used with the model_type property of a ModelMetrics.
MODEL_TYPE_PRE_TRAINED_TEXT_EXTRACTION	A constant which can be used with the model_type property of a ModelMetrics.
dataset_summary	Gets the dataset_summary of this ModelMetrics.
model_type	[Required] Gets the model_type of this ModelMetrics.

Methods:

__init__(**kwargs)	Initializes a new ModelMetrics object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MODEL_TYPE_DOCUMENT_CLASSIFICATION = 'DOCUMENT_CLASSIFICATION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “DOCUMENT_CLASSIFICATION”

MODEL_TYPE_KEY_VALUE_EXTRACTION = 'KEY_VALUE_EXTRACTION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “KEY_VALUE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_DOCUMENT_CLASSIFICATION = 'PRE_TRAINED_DOCUMENT_CLASSIFICATION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_DOCUMENT_CLASSIFICATION”

MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION = 'PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION = 'PRE_TRAINED_KEY_VALUE_EXTRACTION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_KEY_VALUE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_TABLE_EXTRACTION = 'PRE_TRAINED_TABLE_EXTRACTION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_TABLE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_TEXT_EXTRACTION = 'PRE_TRAINED_TEXT_EXTRACTION'

A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_TEXT_EXTRACTION”

__init__(**kwargs)

Initializes a new ModelMetrics object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• PreTrainedDocumentElementsExtractionModelDetails

• DocumentClassificationModelMetrics

• PretrainedDocumentClassificationModelDetails

• PretrainedTableExtractionModelDetails

• KeyValueDetectionModelMetrics

• PretrainedKeyValueExtractionModelDetails

• PretrainedTextExtractionModelDetails

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• model_type (str) – The value to assign to the model_type property of this ModelMetrics. Allowed values for this property are: “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_TEXT_EXTRACTION”, “PRE_TRAINED_TABLE_EXTRACTION”, “PRE_TRAINED_KEY_VALUE_EXTRACTION”, “PRE_TRAINED_DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• dataset_summary (oci.ai_document.models.DatasetSummary) – The value to assign to the dataset_summary property of this ModelMetrics.

property dataset_summary

Gets the dataset_summary of this ModelMetrics.

Returns

The dataset_summary of this ModelMetrics.

Return type

oci.ai_document.models.DatasetSummary

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property model_type

[Required] Gets the model_type of this ModelMetrics. The type of custom model trained.

Allowed values for this property are: “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_TEXT_EXTRACTION”, “PRE_TRAINED_TABLE_EXTRACTION”, “PRE_TRAINED_KEY_VALUE_EXTRACTION”, “PRE_TRAINED_DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this ModelMetrics.

Return type

str