Class: OCI::AiDocument::Models::ModelMetrics

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_document/models/model_metrics.rb

Overview

Trained Model Metrics. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_KEY_VALUE_EXTRACTION = 'KEY_VALUE_EXTRACTION'.freeze,
  MODEL_TYPE_DOCUMENT_CLASSIFICATION = 'DOCUMENT_CLASSIFICATION'.freeze,
  MODEL_TYPE_PRE_TRAINED_TEXT_EXTRACTION = 'PRE_TRAINED_TEXT_EXTRACTION'.freeze,
  MODEL_TYPE_PRE_TRAINED_TABLE_EXTRACTION = 'PRE_TRAINED_TABLE_EXTRACTION'.freeze,
  MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION = 'PRE_TRAINED_KEY_VALUE_EXTRACTION'.freeze,
  MODEL_TYPE_PRE_TRAINED_DOCUMENT_CLASSIFICATION = 'PRE_TRAINED_DOCUMENT_CLASSIFICATION'.freeze,
  MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION = 'PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelMetrics

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 80

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.model_type = attributes[:'modelType'] if attributes[:'modelType']

  raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type')

  self.model_type = attributes[:'model_type'] if attributes[:'model_type']

  self.dataset_summary = attributes[:'datasetSummary'] if attributes[:'datasetSummary']

  raise 'You cannot provide both :datasetSummary and :dataset_summary' if attributes.key?(:'datasetSummary') && attributes.key?(:'dataset_summary')

  self.dataset_summary = attributes[:'dataset_summary'] if attributes[:'dataset_summary']
end

Instance Attribute Details

#dataset_summary ⇒ OCI::AiDocument::Models::DatasetSummary

Returns:



29
30
31
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 29

def dataset_summary
  @dataset_summary
end

#model_type ⇒ String

[Required] The type of custom model trained.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 26

def model_type
  @model_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



32
33
34
35
36
37
38
39
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'dataset_summary': :'datasetSummary'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 56

def self.get_subtype(object_hash)
  type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AiDocument::Models::PreTrainedDocumentElementsExtractionModelDetails' if type == 'PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION'
  return 'OCI::AiDocument::Models::DocumentClassificationModelMetrics' if type == 'DOCUMENT_CLASSIFICATION'
  return 'OCI::AiDocument::Models::PretrainedDocumentClassificationModelDetails' if type == 'PRE_TRAINED_DOCUMENT_CLASSIFICATION'
  return 'OCI::AiDocument::Models::PretrainedTableExtractionModelDetails' if type == 'PRE_TRAINED_TABLE_EXTRACTION'
  return 'OCI::AiDocument::Models::KeyValueDetectionModelMetrics' if type == 'KEY_VALUE_EXTRACTION'
  return 'OCI::AiDocument::Models::PretrainedKeyValueExtractionModelDetails' if type == 'PRE_TRAINED_KEY_VALUE_EXTRACTION'
  return 'OCI::AiDocument::Models::PretrainedTextExtractionModelDetails' if type == 'PRE_TRAINED_TEXT_EXTRACTION'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AiDocument::Models::ModelMetrics'
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'dataset_summary': :'OCI::AiDocument::Models::DatasetSummary'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



119
120
121
122
123
124
125
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 119

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    model_type == other.model_type &&
    dataset_summary == other.dataset_summary
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 150

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


130
131
132
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 139

def hash
  [model_type, dataset_summary].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 183

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



177
178
179
 
# File 'lib/oci/ai_document/models/model_metrics.rb', line 177

def to_s
  to_hash.to_s
end