Class: OCI::AiLanguage::Models::ClassMetrics
- Inherits:
-
Object
- Object
- OCI::AiLanguage::Models::ClassMetrics
- Defined in:
- lib/oci/ai_language/models/class_metrics.rb
Overview
class level Text Classification model metrics
Instance Attribute Summary collapse
-
#f1 ⇒ Float
[Required] F1-score, is a measure of a modelu2019s accuracy on a dataset.
-
#label ⇒ String
[Required] Text classification label.
-
#precision ⇒ Float
[Required] 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).
-
#recall ⇒ Float
[Required] Measures the model's ability to predict actual positive classes.
-
#support ⇒ Float
number of samples in the test set.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ClassMetrics
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ ClassMetrics
Initializes the object
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 68 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.label = attributes[:'label'] if attributes[:'label'] self.f1 = attributes[:'f1'] if attributes[:'f1'] self.precision = attributes[:'precision'] if attributes[:'precision'] self.recall = attributes[:'recall'] if attributes[:'recall'] self.support = attributes[:'support'] if attributes[:'support'] end |
Instance Attribute Details
#f1 ⇒ Float
[Required] F1-score, is a measure of a modelu2019s accuracy on a dataset
17 18 19 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 17 def f1 @f1 end |
#label ⇒ String
[Required] Text classification label
13 14 15 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 13 def label @label end |
#precision ⇒ Float
[Required] 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)
21 22 23 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 21 def precision @precision end |
#recall ⇒ Float
[Required] 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.
25 26 27 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 25 def recall @recall end |
#support ⇒ Float
number of samples in the test set
29 30 31 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 29 def support @support 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 40 41 42 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 32 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'label': :'label', 'f1': :'f1', 'precision': :'precision', 'recall': :'recall', 'support': :'support' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 45 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'label': :'String', 'f1': :'Float', 'precision': :'Float', 'recall': :'Float', 'support': :'Float' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
92 93 94 95 96 97 98 99 100 101 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 92 def ==(other) return true if equal?(other) self.class == other.class && label == other.label && f1 == other.f1 && precision == other.precision && recall == other.recall && support == other.support end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 126 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
106 107 108 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 106 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
115 116 117 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 115 def hash [label, f1, precision, recall, support].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
159 160 161 162 163 164 165 166 167 168 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 159 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
153 154 155 |
# File 'lib/oci/ai_language/models/class_metrics.rb', line 153 def to_s to_hash.to_s end |