Class: NexosisApi::SessionContest

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

Overview

Class to parse the algorithm contestants from a session

Since:

  • 2.0.0

Instance Attribute Summary collapse

Attributes inherited from Session

#column_metadata, #datasource_name, #end_date, #extra_parameters, #links, #messages, #model_id, #prediction_domain, #prediction_intervals, #requested_date, #result_interval, #session_id, #start_date, #status, #status_history, #supports_feature_importance, #target_column, #type

Instance Method Summary collapse

Constructor Details

#initialize(contest_hash) ⇒ SessionContest

Returns a new instance of SessionContest.

Since:

  • 2.0.0



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

def initialize(contest_hash)
  contest_hash.each do |k, v|
    if k.to_s == 'champion'
      instance_variable_set("@#{k}", NexosisApi::AlgorithmContestant.new(v))
    elsif k.to_s == 'contestants'
      instance_variable_set("@#{k}", v.map { |c| NexosisApi::AlgorithmContestant.new(c) })
    elsif k.to_s == 'championMetric'
      @champion_metric = v
    end
  end
  super(contest_hash.reject { |key, _v| key == 'champion' || key == 'contestants' })
end

Instance Attribute Details

#champion ⇒ NexosisApi::AlgorithmContestant

The champion algorithm used

Returns:

Since:

  • 2.0.0



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

def champion
  @champion
end

#champion_metric ⇒ String

Name of metric used to determine champion algorithm

Returns:

  • (String) —

    metric name

Since:

  • 2.0.0



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

def champion_metric
  @champion_metric
end

#contestants ⇒ Array of NexosisApi::AlgorithmContestant

All other algorithms which competed

Returns:

Since:

  • 2.0.0



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

def contestants
  @contestants
end