nexosis_api 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c526af7e9fcefc72090c15c425122bdcb1d84ad
-  data.tar.gz: d8b6c9a510f6c709f1d30cf4a7e63bd9864730cb
+  metadata.gz: a8f386ea632449db904147f0f38b1fbb113633ef
+  data.tar.gz: c6afea0f24270d210be6fea0efa8e8e99be6b6fb
 SHA512:
-  metadata.gz: bbfdbdc1f4da07c9ce8c88c7410ac483929ab07cd298906a31fb60395d5ed39a71c7609d3d69a705c2fba12c39de2102d8420d47ea3077efb6d20e4191e9232d
-  data.tar.gz: c17bdd00ea6712696f731b46193bcb6cd16f9a0f32bbe2c4cbb9e8fb8542e98ae8b13d21fbca517ddbb80c4892380b838215429a407eacbdaa076a51bcc0d0b2
+  metadata.gz: 27fcb7d85fe04fb158a52e2c1dc76f438f4bd8b71380b5d8410cd264081086b4038dc2010dc82ba5a84d5fcc46ce95d3a9836699d993997f243207263f794130
+  data.tar.gz: 88e9204cdfc9fd40e5ee0532acda9a56c7eb73677c301feb47a47886a0909e8a358fb9aa7fdf726992d6874a461a525901111f4a3db7dfc0a599268c37d0cbbb

data/lib/nexosis_api/classifier_result.rb

@@ -0,0 +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

data/lib/nexosis_api/client.rb

@@ -2,6 +2,7 @@ require 'nexosis_api/algorithm_run'
 require 'nexosis_api/algorithm_selection'
 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'
@@ -15,6 +16,7 @@ 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'

data/lib/nexosis_api/client/sessions.rb

@@ -157,15 +157,19 @@ module NexosisApi
       # @param datasource_name [String] The datasource from which to build the model
       # @param target_column [String] The column which will be predicted when using the model
       # @param columns [Hash] column metadata to modify roles, imputation, or target.
+      # @param options [Hash] prediction_domain and or balanced indicator for classification
+      # @note - classifcation assumes balanced classes. The use of a 'balanced=false' option
+      # indicates that no attempt should be made to sample the classes in balanced fashion.
       # @since 1.3.0
-      def create_model(datasource_name, target_column, columns = {})
+      def create_model(datasource_name, target_column, columns = {}, options = { prediction_domain: 'regression' })
         model_url = '/sessions/model'
         body = {
           dataSourceName: datasource_name,
           targetColumn: target_column,
-          predictionDomain: 'regression',
+          predictionDomain: options[:prediction_domain].downcase,
           isEstimate: false
         }
+        body.store(:balance, options[:balance]) if options.include?(:balance) && body[:predictionDomain] == 'classification'
         body.store(columns: columns) unless columns.empty?
         response = self.class.post(model_url, headers: @headers, body: body.to_json)
         if response.success?
@@ -176,6 +180,18 @@ module NexosisApi
         end
       end
 
+      # Get the confusion matrix for a completed classification session
+      # @param session_id [String] The unique id of the completed classification session
+      # @return [NexosisApi::ClassifierResult] a confusion matrix along with class labels and other session information.
+      # @since 1.4.1
+      # @note - This endpoint returns a 404 for requests of non-classification sessions
+      def get_confusion_matrix(session_id)
+        result_url = "/sessions/#{session_id}/results/confusionmatrix"
+        response = self.class.get(result_url, headers: @headers)
+        raise HttpException.new("There was a problem getting a confusion matrix for session #{session_id}", 'getting confusion matrix', response) unless response.success?
+        NexosisApi::ClassifierResult.new(response.parsed_response)
+      end
+
       private
 
       # @private
@@ -205,7 +221,7 @@ module NexosisApi
           session_hash = { 'session' => response.parsed_response }.merge(response.headers)
           NexosisApi::SessionResponse.new(session_hash)
         else
-          raise HttpException.new("Unable to create new #{type} session", "Create session for dataset #{dataset_name}",response)
+          raise HttpException.new("Unable to create new #{type} session", "Create session for dataset #{dataset_name}", response)
         end
       end
 

data/lib/nexosis_api/message.rb

@@ -0,0 +1,19 @@
+module NexosisApi
+  # class to provide message responses
+  # @since 1.4.1
+  class Message
+    def initialize(message_hash)
+      message_hash.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # The type of message: information, warning, or error
+    # @return [String]
+    attr_accessor :severity
+
+    # The content of the message
+    # @return [String]
+    attr_accessor :message
+  end
+end

data/lib/nexosis_api/session.rb

@@ -8,7 +8,8 @@ module NexosisApi
                   'sessionId' => :@session_id,
                   'availablePredictionIntervals' => :@prediction_intervals,
                   'startDate' => :@start_date,
-                  'endDate' => :@end_date }
+                  'endDate' => :@end_date,
+                  'predictionDomain' => :@prediction_domain }
       session_hash.each do |k, v|
         if (k == 'links')
           @links = v.map { |l| NexosisApi::Link.new(l) }
@@ -19,6 +20,8 @@ module NexosisApi
                               end
         elsif (k == 'requestedDate')
           @requested_date = DateTime.parse(v)
+        elsif (k == 'messages')
+          @messages = v.map { |m| NexosisApi::Message.new(m) } unless v.empty?
         else
           instance_variable_set("@#{k}", v) unless v.nil?
         end
@@ -121,5 +124,20 @@ module NexosisApi
     #    this list for other intervals which can be requested.
     # @since 1.4.0
     attr_accessor :prediction_intervals
+
+    # The type of model if a model creation session
+    # @return [String]
+    # @since 1.4.1
+    attr_accessor :prediction_domain
+
+    # A list of warning or error messages optionally returned from session
+    # @return [Array of Message]
+    attr_accessor :messages
+
+    # Whether classes were sampled as balanced in the context of a classification model
+    # @return [Boolean]
+    # @note - the default is true and has no means outside of classification
+    # @since 1.4.1
+    attr_accessor :balance
   end
 end

data/lib/nexosis_api/session_response.rb

@@ -11,6 +11,8 @@ module NexosisApi
           instance_variable_set('@cost', v[0]) unless v.nil?
         elsif(k == 'nexosis-account-balance')
           instance_variable_set('@account_balance', v[0]) unless v.nil?
+        elsif(k == 'balance')
+          @balance = v
         end
       end
     end

data/nexosisapi.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
   spec.summary = "Ruby client for working with the Nexosis API"
-  spec.version = '1.4.0'
+  spec.version = '1.4.1'
   spec.metadata["yard.run"] = "yri"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexosis_api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - lib/nexosis_api/algorithm_run.rb
 - lib/nexosis_api/algorithm_selection.rb
 - lib/nexosis_api/calendar_jointarget.rb
+- lib/nexosis_api/classifier_result.rb
 - lib/nexosis_api/client.rb
 - lib/nexosis_api/client/datasets.rb
 - lib/nexosis_api/client/imports.rb
@@ -69,6 +70,7 @@ files:
 - lib/nexosis_api/imports_response.rb
 - lib/nexosis_api/join.rb
 - lib/nexosis_api/link.rb
+- lib/nexosis_api/message.rb
 - lib/nexosis_api/metric.rb
 - lib/nexosis_api/model_summary.rb
 - lib/nexosis_api/paged_array.rb