Class: NexosisApi::Metric

Inherits:

Object

• Object
• NexosisApi::Metric

Defined in:

lib/nexosis_api/metric.rb

Overview

Class to parse algorithm metrics from model results

Instance Attribute Summary

• #code ⇒ String

  Identifier for metric type.

• #name ⇒ String

  Friendly name of the metric.

• #value ⇒ Float

  Calculated metric.

Instance Method Summary

• #initialize(metricHash) ⇒ Metric constructor

  A new instance of Metric.

Constructor Details

#initialize(metricHash) ⇒ Metric

Returns a new instance of Metric.

# File 'lib/nexosis_api/metric.rb', line 4

def initialize(metricHash)
   metricHash.each do |k,v|
       instance_variable_set("@#{k}", v) unless v.nil?
   end
end

Instance Attribute Details

#code ⇒ String

Identifier for metric type

Returns:

• (String)

# File 'lib/nexosis_api/metric.rb', line 16

def code
  @code
end

#name ⇒ String

Friendly name of the metric

Returns:

• (String)

# File 'lib/nexosis_api/metric.rb', line 12

def name
  @name
end

#value ⇒ Float

Calculated metric

Returns:

• (Float)

# File 'lib/nexosis_api/metric.rb', line 20

def value
  @value
end