Class: OCI::GenerativeAi::Models::TextGenerationModelMetrics

Inherits:
ModelMetrics
  • Object
show all
Defined in:
lib/oci/generative_ai/models/text_generation_model_metrics.rb

Overview

The text generation model metrics of the fine-tuning process.

Constant Summary

Constants inherited from ModelMetrics

ModelMetrics::MODEL_METRICS_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ModelMetrics

#model_metrics_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ModelMetrics

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ TextGenerationModelMetrics

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :final_accuracy (Float) —

    The value to assign to the #final_accuracy property

  • :final_loss (Float) —

    The value to assign to the #final_loss property



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 51

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

  attributes['modelMetricsType'] = 'TEXT_GENERATION_MODEL_METRICS'

  super(attributes)

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

  self.final_accuracy = attributes[:'finalAccuracy'] if attributes[:'finalAccuracy']

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

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

  self.final_loss = attributes[:'finalLoss'] if attributes[:'finalLoss']

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

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

Instance Attribute Details

#final_accuracy ⇒ Float

Fine-tuned model accuracy.

Returns:

  • (Float) 


15
16
17
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 15

def final_accuracy
  @final_accuracy
end

#final_loss ⇒ Float

Fine-tuned model loss.

Returns:

  • (Float) 


19
20
21
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 19

def final_loss
  @final_loss
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_metrics_type': :'modelMetricsType',
    'final_accuracy': :'finalAccuracy',
    'final_loss': :'finalLoss'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 33

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_metrics_type': :'String',
    'final_accuracy': :'Float',
    'final_loss': :'Float'
    # 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



81
82
83
84
85
86
87
88
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 81

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

  self.class == other.class &&
    model_metrics_type == other.model_metrics_type &&
    final_accuracy == other.final_accuracy &&
    final_loss == other.final_loss
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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 113

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


93
94
95
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 93

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 102

def hash
  [model_metrics_type, final_accuracy, final_loss].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 146

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



140
141
142
 
# File 'lib/oci/generative_ai/models/text_generation_model_metrics.rb', line 140

def to_s
  to_hash.to_s
end