Class: NexosisApi::ModelSummary

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

Overview

class to hold the parsed results of model summary json

Since:

  • 1.3.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_hash) ⇒ ModelSummary

Returns a new instance of ModelSummary.

Since:

  • 1.3.0



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/nexosis_api/model_summary.rb', line 5

def initialize(model_hash)
  model_hash.each do |k, v|
    k = k.to_s
    if (k == 'modelId')
      @model_id = v
    elsif (k == 'predictionDomain')
      @prediction_domain = v
    elsif (k == 'dataSourceName')
      @datasource_name = v
    elsif (k == 'createdDate')
      @created_date = DateTime.parse(v) unless v.nil?
    elsif (k == 'algorithm')
      @algorithm = NexosisApi::Algorithm.new(v) unless v.nil?
    elsif (k == 'columns')
      @column_metadata = v.reject { |_key, value| value.nil? }
                          .map do |col_key, col_val|
                            NexosisApi::Column.new(col_key, col_val)
                          end
    elsif (k == 'metrics')
      @metrics = v.reject { |_key, value| value.nil? }
                  .map do |col_key, col_val|
                    NexosisApi::Metric.new(col_key, col_val)
                  end
    elsif (k == 'sessionId')
      @session_id = v
    end
  end
end

Instance Attribute Details

#algorithm ⇒ NexosisApi::Algorithm

Information about the algorithm used to create the model

Returns:

Since:

  • 1.3.0



56
57
58
 
# File 'lib/nexosis_api/model_summary.rb', line 56

def algorithm
  @algorithm
end

#column_metadata ⇒ Array of NexosisApi::Column

Descriptive information about the columns

Returns:

Since:

  • 1.3.0



60
61
62
 
# File 'lib/nexosis_api/model_summary.rb', line 60

def column_metadata
  @column_metadata
end

#created_date ⇒ DateTime

The date on which this model was created.

Returns:

  • (DateTime)

Since:

  • 1.3.0



52
53
54
 
# File 'lib/nexosis_api/model_summary.rb', line 52

def created_date
  @created_date
end

#datasource_name ⇒ String

The data source used to create this model

Returns:

  • (String)

Since:

  • 1.3.0



48
49
50
 
# File 'lib/nexosis_api/model_summary.rb', line 48

def datasource_name
  @datasource_name
end

#metrics ⇒ Array of NexosisApi::Metric

Algorithm and model specific metrics which may be of interest

Returns:

Since:

  • 1.3.0



64
65
66
 
# File 'lib/nexosis_api/model_summary.rb', line 64

def metrics
  @metrics
end

#model_id ⇒ String

Unique model id for this model in uuid/guid format.

Returns:

  • (String)

Since:

  • 1.3.0



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

def model_id
  @model_id
end

#prediction_domain ⇒ String (readonly)

The type of prediction performed

Returns:

  • (String)

Since:

  • 1.3.0



44
45
46
 
# File 'lib/nexosis_api/model_summary.rb', line 44

def prediction_domain
  @prediction_domain
end

#session_id ⇒ String

Unique id of the session used to create this model instance

Returns:

  • (String)

Since:

  • 1.3.0



40
41
42
 
# File 'lib/nexosis_api/model_summary.rb', line 40

def session_id
  @session_id
end