nexosis_api 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05b7aebc636b47c645dc8ca1d8440dde6c26f523
-  data.tar.gz: 29acd4e727fe0e346fa7fcf4d55ad51a45c3de41
+  metadata.gz: c12a9dee350193af3df27068feb8161999a7d085
+  data.tar.gz: c2f3cd6d4b24c211a4eab0c5bd2ed07dd4e6b132
 SHA512:
-  metadata.gz: 3dfd4f118c8a030fb867d370b3262f995d3e2ef516d8e887dc3d9e4d6a964780e40dba3e08bd399dc04613e82ca923b12f078f57dd2775bb89246f6b8f26732c
-  data.tar.gz: e81a1e499369c1a61e603ed0ce35da9f846718d91646cecd4bd95e0eaf3d6c346f5f558703128c92f9a8f805130db1987893302cd776e132b07595b978011290
+  metadata.gz: 59e8f973c4aa67adb891ef177deeb8571ed99413a8efb6fc826e46058d286e9a308e1d87c014294ce9a4ae2e8b756402f0b592dbb1b31ba0cebfc9686360a17f
+  data.tar.gz: b3952c5b3d130305511310e4b77f028ada6832e90ecf1d113f8c842ece1ee2a82754553863d3766998c8c61da6fca998b4afda20de84b11042fd65ecff07ea74

data/lib/nexosis_api.rb

@@ -1,12 +1,12 @@
-require 'httparty'
-require 'nexosis_api/client'
-
-# The container for the Nexosis API Client
-module NexosisApi
-  class << self
-    def client options = {}
-      return @client if defined?(@client)
-      @client = NexosisApi::Client.new(options)
-    end
-  end
+require 'httparty'
+require 'nexosis_api/client'
+
+# The container for the Nexosis API Client
+module NexosisApi
+  class << self
+    def client options = {}
+      return @client if defined?(@client)
+      @client = NexosisApi::Client.new(options)
+    end
+  end
 end

data/lib/nexosis_api/algorithm.rb

@@ -1,22 +1,22 @@
-module NexosisApi
-  # Class to parse an individual algorithm
-  class Algorithm
-    def initialize(algo_hash)
-      algo_hash.each do |k, v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-
-    # A unique identififer for the algorithm
-    # @return [String]
-    attr_accessor :key
-
-    # A friendly name for the algorithm
-    # @return [String]
-    attr_accessor :name
-
-    # Descriptive explanation of the algorithm implementation
-    # @return [String]
-    attr_accessor :description
-  end
-end
+module NexosisApi
+  # Class to parse an individual algorithm
+  class Algorithm
+    def initialize(algo_hash)
+      algo_hash.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # A unique identififer for the algorithm
+    # @return [String]
+    attr_accessor :key
+
+    # A friendly name for the algorithm
+    # @return [String]
+    attr_accessor :name
+
+    # Descriptive explanation of the algorithm implementation
+    # @return [String]
+    attr_accessor :description
+  end
+end

data/lib/nexosis_api/algorithm_contestant.rb

@@ -1,43 +1,43 @@
-module NexosisApi
-  # Class to parse results of an algorithm run
-  # @since 2.0.0
-  class AlgorithmContestant
-    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
-
-    # Unique identifier for this contestant
-    attr_reader :id
-
-    # Identifier of algorithm run
-    # @return [NexosisApi::Algorithm]
-    attr_accessor :algorithm
-
-    # Name and value for metrics calculated for this algorithm
-    # @return [Hash]
-    attr_accessor :metrics
-
-    # Relevant hypermedia as {NexosisApi::Link}
-    # @return [Array]
-    attr_accessor :links
-
-    # Operations performed on datasource prior to run
-    # @return [Array]
-    attr_reader :datasource_properties
-
-    # The test dataset used to score the algo
-    # @return [Array of Hash] columnname: value hash of each observation row in test set
-    # @note - may be nil when reviewing contestant lists
-    attr_reader :data
-  end
-end
+module NexosisApi
+  # Class to parse results of an algorithm run
+  # @since 2.0.0
+  class AlgorithmContestant
+    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
+
+    # Unique identifier for this contestant
+    attr_reader :id
+
+    # Identifier of algorithm run
+    # @return [NexosisApi::Algorithm]
+    attr_accessor :algorithm
+
+    # Name and value for metrics calculated for this algorithm
+    # @return [Hash]
+    attr_accessor :metrics
+
+    # Relevant hypermedia as {NexosisApi::Link}
+    # @return [Array]
+    attr_accessor :links
+
+    # Operations performed on datasource prior to run
+    # @return [Array]
+    attr_reader :datasource_properties
+
+    # The test dataset used to score the algo
+    # @return [Array of Hash] columnname: value hash of each observation row in test set
+    # @note - may be nil when reviewing contestant lists
+    attr_reader :data
+  end
+end

data/lib/nexosis_api/anomaly_scores.rb

@@ -0,0 +1,19 @@
+require 'nexosis_api/session_response'
+module NexosisApi
+  # class to hold the parsed results of an anomalyScores request
+  # @since 2.1.0
+  class AnomalyScores < SessionResponse
+    def initialize(result_hash)
+      @data = NexosisApi::PagedArray.new(result_hash, result_hash['data'])
+      @percent_anomalies = result_hash['metrics']['percentAnomalies'] unless result_hash['metrics'].nil?
+      super(result_hash.reject { |k, _v| k.to_s == 'data' || k.to_s == 'metrics' })
+    end
+
+    # The anomalies found while building your model.
+    # @return [NexosisApi::PagedArray] per observation feature scores of the form {"target_col": "0.3882", "col_1" : "0.828", "target_col:actual" : "0.402"} 
+    attr_reader :data
+
+    # The percent of observations found to be anomalous in the training data set
+    attr_reader :percent_anomalies
+  end
+end

data/lib/nexosis_api/calendar_jointarget.rb

@@ -1,35 +1,35 @@
-module NexosisApi
-  # Specifies the details of a calendar data source to join to
-  # @see http://docs.nexosis.com/guides/calendars
-  # @since 1.2.3
-  class CalendarJoinTarget
-    def initialize(cal_join_hash)
-      @url = cal_join_hash['url'] unless cal_join_hash.nil?
-      @name = cal_join_hash['name'] unless cal_join_hash.nil?
-      @timezone = cal_join_hash['timeZone'] unless cal_join_hash.nil?
-    end
-
-    # The location of a public iCal to download as the datasource
-    # @return [String]
-    attr_accessor :url
-
-    # The name of a well-known Nexosis calendar.
-    # @return [String]
-    # @see http://docs.nexosis.com/guides/datasources
-    attr_accessor :name
-
-    # tz-db string name of the timezone of the calendar
-    # @return [String]
-    # @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-    attr_accessor :timezone
-
-    # custom hash to match with api requests
-    def to_hash
-      hash = { 'calendar' => {} }
-      hash['calendar'].store 'url', url unless url.nil?
-      hash['calendar'].store 'name', name unless name.nil?
-      hash['calendar'].store 'timeZone', name unless timezone.nil?
-      hash
-    end
-  end
-end
+module NexosisApi
+  # Specifies the details of a calendar data source to join to
+  # @see http://docs.nexosis.com/guides/calendars
+  # @since 1.2.3
+  class CalendarJoinTarget
+    def initialize(cal_join_hash)
+      @url = cal_join_hash['url'] unless cal_join_hash.nil?
+      @name = cal_join_hash['name'] unless cal_join_hash.nil?
+      @timezone = cal_join_hash['timeZone'] unless cal_join_hash.nil?
+    end
+
+    # The location of a public iCal to download as the datasource
+    # @return [String]
+    attr_accessor :url
+
+    # The name of a well-known Nexosis calendar.
+    # @return [String]
+    # @see http://docs.nexosis.com/guides/datasources
+    attr_accessor :name
+
+    # tz-db string name of the timezone of the calendar
+    # @return [String]
+    # @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+    attr_accessor :timezone
+
+    # custom hash to match with api requests
+    def to_hash
+      hash = { 'calendar' => {} }
+      hash['calendar'].store 'url', url unless url.nil?
+      hash['calendar'].store 'name', name unless name.nil?
+      hash['calendar'].store 'timeZone', name unless timezone.nil?
+      hash
+    end
+  end
+end

data/lib/nexosis_api/classifier_result.rb

@@ -1,25 +1,25 @@
-require 'nexosis_api/session'
-module NexosisApi
-  # class to hold parsed results of confusion matrix request
-  # @since 1.4.1
-  class ClassifierResult < Session
-    def initialize(classify_result)
-      classify_result.each do |k, v|
-        if (k.to_s == 'confusionMatrix')
-          @confusion_matrix = v
-        elsif (k.to_s == 'classes')
-          @classes = v
-        end
-      end
-      super(classify_result)
-    end
-
-    # array of arrays to form confusion matrix results
-    # @return [Array of Array of Int] - the class counts for expected to predicted
-    attr_accessor :confusion_matrix
-
-    # Class labels in index order of matrix arrays
-    # @return [Array]
-    attr_accessor :classes
-  end
-end
+require 'nexosis_api/session'
+module NexosisApi
+  # class to hold parsed results of confusion matrix request
+  # @since 1.4.1
+  class ClassifierResult < Session
+    def initialize(classify_result)
+      classify_result.each do |k, v|
+        if (k.to_s == 'confusionMatrix')
+          @confusion_matrix = v
+        elsif (k.to_s == 'classes')
+          @classes = v
+        end
+      end
+      super(classify_result)
+    end
+
+    # array of arrays to form confusion matrix results
+    # @return [Array of Array of Int] - the class counts for expected to predicted
+    attr_accessor :confusion_matrix
+
+    # Class labels in index order of matrix arrays
+    # @return [Array]
+    attr_accessor :classes
+  end
+end

data/lib/nexosis_api/classifier_scores.rb

@@ -0,0 +1,26 @@
+require 'nexosis_api/session_response'
+module NexosisApi
+  # class to hold parsed results of classifier scores request
+  # @since 2.1.0
+  class ClassifierScores < SessionResponse
+    def initialize(classify_scores)
+      props = %w[data metrics classes]
+      classify_scores.select { |k, _v| props.include? k }.each { |k, v| instance_variable_set("@#{k}", v) }
+      @data = NexosisApi::PagedArray.new(classify_scores, classify_scores['data'])
+      super(classify_scores.reject { |k, _v| props.include? k })
+    end
+
+    # array of hashes with each class and its scored result
+    # @return [NexosisApi::PagedArray] - the class result along with scores for each candidate class
+    # @note the hash takes the form {"target": "class2", "target:class1": "3.21545", "target:class2":"4.2654", "feature1": "value", "target:actual": "class2"}
+    attr_reader :data
+
+    # Class labels represented in the data
+    # @return [Array]
+    attr_reader :classes
+
+    # metrics of the classification model building session
+    # @return [Hash] name value pairs of metrics
+    attr_reader :metrics
+  end
+end

data/lib/nexosis_api/client.rb

@@ -1,118 +1,120 @@
-require 'nexosis_api/algorithm_contestant'
-require 'nexosis_api/algorithm'
-require 'nexosis_api/calendar_jointarget'
-require 'nexosis_api/classifier_result'
-require 'nexosis_api/column'
-require 'nexosis_api/column_options'
-require 'nexosis_api/column_role'
-require 'nexosis_api/column_type'
-require 'nexosis_api/dataset_data'
-require 'nexosis_api/dataset_jointarget'
-require 'nexosis_api/dataset_model'
-require 'nexosis_api/dataset_summary'
-require 'nexosis_api/http_exception'
-require 'nexosis_api/impact_metric'
-require 'nexosis_api/imports_response'
-require 'nexosis_api/join'
-require 'nexosis_api/link'
-require 'nexosis_api/message'
-require 'nexosis_api/metric'
-require 'nexosis_api/model_summary'
-require 'nexosis_api/paged_array'
-require 'nexosis_api/predict_response'
-require 'nexosis_api/session_contest'
-require 'nexosis_api/session_response'
-require 'nexosis_api/session_result'
-require 'nexosis_api/session_selection_metrics'
-require 'nexosis_api/session'
-require 'nexosis_api/time_interval'
-require 'nexosis_api/view_definition'
-require 'nexosis_api/view_data'
-require 'nexosis_api/client/contest'
-require 'nexosis_api/client/sessions'
-require 'nexosis_api/client/datasets'
-require 'nexosis_api/client/imports'
-require 'nexosis_api/client/views'
-require 'nexosis_api/client/models'
-
-module NexosisApi
-  # Primary entry point to working with Nexosis API
-  class Client
-    include HTTParty
-    base_uri 'https://ml.nexosis.com/v1'
-    include Client::Sessions
-    include Client::Datasets
-    include Client::Imports
-    include Client::Views
-    include Client::Models
-    include Client::Contest
-
-    def initialize(options = {})
-      raise ArgumentError, 'api_key was not defined' unless options[:api_key].nil? == false
-      @api_key = options[:api_key]
-      self.class.base_uri options[:base_uri] unless options[:base_uri].nil?
-      @headers = { 'api-key' => @api_key, 'Content-Type' => 'application/json',
-                   'User-Agent' => 'Nexosis-Ruby-API-Client/1.2' }
-      @options = { headers: @headers, format: :json }
-    end
-
-    # Gets the quota stats for the account
-    #
-    # @return [Hash] a hash of quota values and current values
-    def get_account_quotas()
-      session_url = '/sessions?page=0&pageSize=1'
-      response = self.class.get(session_url, @options)
-      response.headers.select { |k, _v| k.to_s.start_with? 'nexosis-account' }
-    end
-
-    # Provide access to read or modify the api key
-    # @return [String]
-    # @since 2.0.0
-    def api_key(value)
-      @api_key = value unless value.nil?
-      @headers['api-key'] = @api_key
-      @api_key
-    end
-
-    private
-
-    # @private
-    def process_csv_to_s csv
-      content = ''
-      if(csv.is_a?(CSV))
-        csv.each do |row|
-          if(csv.headers.nil?)
-            # not using row.to_csv because it uses non-compliant '\n' newline
-            content.concat(row.join(',')).concat("\r\n")
-          else
-            content.concat(row.fields.join(',')).concat("\r\n")
-          end
-        end
-        if(csv.headers.nil? == false)
-          content.prepend(csv.headers.join(',').concat("\r\n")) unless csv.headers.nil?
-        end
-      else
-        content = csv
-      end
-      content
-    end
-
-    # @private
-    def create_query(page_number, page_size, options = {})
-      options.store(:page_number, page_number)
-      options.store(:page_size, page_size)
-      query = {
-        'page' => [page_number],
-        'pageSize' => [page_size]
-      }
-      query['startDate'] = [options[:start_date].iso8601.gsub(/\+/,'%2B')] unless options[:start_date].nil?
-      query['endDate'] = [options[:end_date].iso8601.gsub(/\+/,'%2B')] unless options[:end_date].nil?
-      query['include'] = options[:include] unless options[:include].nil?
-      query
-    end
-
-    def array_query_normalizer(query_set)
-      query_set.map { |key, value| value.map { |v| "#{key}=#{v}" } }.join('&')
-    end
-  end
-end
+require 'nexosis_api/algorithm_contestant'
+require 'nexosis_api/algorithm'
+require 'nexosis_api/anomaly_scores'
+require 'nexosis_api/calendar_jointarget'
+require 'nexosis_api/classifier_result'
+require 'nexosis_api/classifier_scores'
+require 'nexosis_api/column'
+require 'nexosis_api/column_options'
+require 'nexosis_api/column_role'
+require 'nexosis_api/column_type'
+require 'nexosis_api/dataset_data'
+require 'nexosis_api/dataset_jointarget'
+require 'nexosis_api/dataset_model'
+require 'nexosis_api/dataset_summary'
+require 'nexosis_api/http_exception'
+require 'nexosis_api/impact_metric'
+require 'nexosis_api/imports_response'
+require 'nexosis_api/join'
+require 'nexosis_api/link'
+require 'nexosis_api/message'
+require 'nexosis_api/metric'
+require 'nexosis_api/model_summary'
+require 'nexosis_api/paged_array'
+require 'nexosis_api/predict_response'
+require 'nexosis_api/session_contest'
+require 'nexosis_api/session_response'
+require 'nexosis_api/session_result'
+require 'nexosis_api/session_selection_metrics'
+require 'nexosis_api/session'
+require 'nexosis_api/time_interval'
+require 'nexosis_api/view_definition'
+require 'nexosis_api/view_data'
+require 'nexosis_api/client/contest'
+require 'nexosis_api/client/sessions'
+require 'nexosis_api/client/datasets'
+require 'nexosis_api/client/imports'
+require 'nexosis_api/client/views'
+require 'nexosis_api/client/models'
+
+module NexosisApi
+  # Primary entry point to working with Nexosis API
+  class Client
+    include HTTParty
+    base_uri 'https://ml.nexosis.com/v1'
+    include Client::Sessions
+    include Client::Datasets
+    include Client::Imports
+    include Client::Views
+    include Client::Models
+    include Client::Contest
+
+    def initialize(options = {})
+      raise ArgumentError, 'api_key was not defined' unless options[:api_key].nil? == false
+      @api_key = options[:api_key]
+      self.class.base_uri options[:base_uri] unless options[:base_uri].nil?
+      @headers = { 'api-key' => @api_key, 'Content-Type' => 'application/json',
+                   'User-Agent' => 'Nexosis-Ruby-API-Client/2.1' }
+      @options = { headers: @headers, format: :json }
+    end
+
+    # Gets the quota stats for the account
+    #
+    # @return [Hash] a hash of quota values and current values
+    def get_account_quotas()
+      session_url = '/sessions?page=0&pageSize=1'
+      response = self.class.get(session_url, @options)
+      response.headers.select { |k, _v| k.to_s.start_with? 'nexosis-account' }
+    end
+
+    # Provide access to read or modify the api key
+    # @return [String]
+    # @since 2.0.0
+    def api_key(value)
+      @api_key = value unless value.nil?
+      @headers['api-key'] = @api_key
+      @api_key
+    end
+
+    private
+
+    # @private
+    def process_csv_to_s csv
+      content = ''
+      if(csv.is_a?(CSV))
+        csv.each do |row|
+          if(csv.headers.nil?)
+            # not using row.to_csv because it uses non-compliant '\n' newline
+            content.concat(row.join(',')).concat("\r\n")
+          else
+            content.concat(row.fields.join(',')).concat("\r\n")
+          end
+        end
+        if(csv.headers.nil? == false)
+          content.prepend(csv.headers.join(',').concat("\r\n")) unless csv.headers.nil?
+        end
+      else
+        content = csv
+      end
+      content
+    end
+
+    # @private
+    def create_query(page_number, page_size, options = {})
+      options.store(:page_number, page_number)
+      options.store(:page_size, page_size)
+      query = {
+        'page' => [page_number],
+        'pageSize' => [page_size]
+      }
+      query['startDate'] = [options[:start_date].iso8601.gsub(/\+/,'%2B')] unless options[:start_date].nil?
+      query['endDate'] = [options[:end_date].iso8601.gsub(/\+/,'%2B')] unless options[:end_date].nil?
+      query['include'] = options[:include] unless options[:include].nil?
+      query
+    end
+
+    def array_query_normalizer(query_set)
+      query_set.map { |key, value| value.map { |v| "#{key}=#{v}" } }.join('&')
+    end
+  end
+end