class OCI::AiAnomalyDetection::Models::ModelTrainingResults

Specifies the details for an Anomaly Detection model trained with MSET.

Attributes

fap[RW]

[Required] The final-achieved model accuracy metric on individual value level @return [Float]

is_training_goal_achieved[RW]

A boolean value to indicate if train goal/targetFap is achieved for trained model @return [BOOLEAN]

multivariate_fap[RW]

The model accuracy metric on timestamp level. @return [Float]

row_reduction_details[RW]

@return [OCI::AiAnomalyDetection::Models::RowReductionDetails]

signal_details[RW]

The list of signal details. @return [Array<OCI::AiAnomalyDetection::Models::PerSignalDetails>]

warning[RW]

A warning message to explain the reason when targetFap cannot be achieved for trained model @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 34
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'fap': :'fap',
    'multivariate_fap': :'multivariateFap',
    'is_training_goal_achieved': :'isTrainingGoalAchieved',
    'warning': :'warning',
    'signal_details': :'signalDetails',
    'row_reduction_details': :'rowReductionDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Float] :fap The value to assign to the {#fap} property @option attributes [Float] :multivariate_fap The value to assign to the {#multivariate_fap} property @option attributes [BOOLEAN] :is_training_goal_achieved The value to assign to the {#is_training_goal_achieved} property @option attributes [String] :warning The value to assign to the {#warning} property @option attributes [Array<OCI::AiAnomalyDetection::Models::PerSignalDetails>] :signal_details The value to assign to the {#signal_details} property @option attributes [OCI::AiAnomalyDetection::Models::RowReductionDetails] :row_reduction_details The value to assign to the {#row_reduction_details} property

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 73
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.fap = attributes[:'fap'] if attributes[:'fap']

  self.multivariate_fap = attributes[:'multivariateFap'] if attributes[:'multivariateFap']

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

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

  self.is_training_goal_achieved = attributes[:'isTrainingGoalAchieved'] unless attributes[:'isTrainingGoalAchieved'].nil?

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

  self.is_training_goal_achieved = attributes[:'is_training_goal_achieved'] unless attributes[:'is_training_goal_achieved'].nil?

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

  self.signal_details = attributes[:'signalDetails'] if attributes[:'signalDetails']

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

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

  self.row_reduction_details = attributes[:'rowReductionDetails'] if attributes[:'rowReductionDetails']

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

  self.row_reduction_details = attributes[:'row_reduction_details'] if attributes[:'row_reduction_details']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 48
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'fap': :'Float',
    'multivariate_fap': :'Float',
    'is_training_goal_achieved': :'BOOLEAN',
    'warning': :'String',
    'signal_details': :'Array<OCI::AiAnomalyDetection::Models::PerSignalDetails>',
    'row_reduction_details': :'OCI::AiAnomalyDetection::Models::RowReductionDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 115
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    fap == other.fap &&
    multivariate_fap == other.multivariate_fap &&
    is_training_goal_achieved == other.is_training_goal_achieved &&
    warning == other.warning &&
    signal_details == other.signal_details &&
    row_reduction_details == other.row_reduction_details
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/ai_anomaly_detection/models/model_training_results.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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 130
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 139
def hash
  [fap, multivariate_fap, is_training_goal_achieved, warning, signal_details, row_reduction_details].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/ai_anomaly_detection/models/model_training_results.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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 177
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/ai_anomaly_detection/models/model_training_results.rb, line 200
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end