Class: NexosisApi::AlgorithmContestant

Inherits:
Object
  • Object
show all
Defined in:
lib/nexosis_api/algorithm_contestant.rb

Overview

Class to parse results of an algorithm run

Since:

  • 2.0.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(contestant_hash) ⇒ AlgorithmContestant

Returns a new instance of AlgorithmContestant.

Since:

  • 2.0.0



5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 5

def initialize(contestant_hash)
  contestant_hash.each do |k, v|
    if k.to_s == 'links'
      instance_variable_set("@#{k}", v.map { |l| NexosisApi::Link.new(l) unless l.nil? })
    elsif k.to_s == 'dataSourceProperties'
      @datasource_properties = v
    elsif k.to_s == 'algorithm'
      instance_variable_set("@#{k}", NexosisApi::Algorithm.new(v)) unless v.nil?
    else
      instance_variable_set("@#{k}", v)
    end
  end
end

Instance Attribute Details

#algorithm ⇒ NexosisApi::Algorithm

Identifier of algorithm run

Returns:

Since:

  • 2.0.0



24
25
26
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 24

def algorithm
  @algorithm
end

#data ⇒ Array of Hash (readonly)

Note:

  • may be nil when reviewing contestant lists

The test dataset used to score the algo

Returns:

  • (Array of Hash) —

    columnname: value hash of each observation row in test set

Since:

  • 2.0.0



41
42
43
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 41

def data
  @data
end

#datasource_properties ⇒ Array (readonly)

Operations performed on datasource prior to run

Returns:

  • (Array)

Since:

  • 2.0.0



36
37
38
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 36

def datasource_properties
  @datasource_properties
end

#id ⇒ Object (readonly)

Unique identifier for this contestant

Since:

  • 2.0.0



20
21
22
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 20

def id
  @id
end

#links ⇒ Array

Relevant hypermedia as Link

Returns:

  • (Array)

Since:

  • 2.0.0



32
33
34
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 32

def links
  @links
end

#metrics ⇒ Hash

Name and value for metrics calculated for this algorithm

Returns:

  • (Hash)

Since:

  • 2.0.0



28
29
30
 
# File 'lib/nexosis_api/algorithm_contestant.rb', line 28

def metrics
  @metrics
end