rumale 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7caefe8d0715984980daede523f1944460bcff7dd782c431b7e95d851ddfbf82
-  data.tar.gz: 05ba1863410dcaabd31dc281c921011a9625f75980c137ab8c88f302c33042b5
+  metadata.gz: 1b344bc829bda6e2b5f60baba450f3c38d5f90ebf0c0cfccd02d2894189d540e
+  data.tar.gz: 91fcce138ced31e94363b6f137bd66b6e1637d1fb5d03a1b1b531a3e1d2a3502
 SHA512:
-  metadata.gz: 06a95f1fda83e546954e235f06c5b487cc393a340c48b1316b9ef2d0fafbb5be4bb4de02681c6b7b013915695ecd06a04a8692c9df2ba9822e3ba4e01925c0df
-  data.tar.gz: 0e5e1ae19fbb420cba2914f251b8ba44de29f4eb9feed31d5bcdb0dc4003a9221053bedddc3214faf8803282965c9dbd51c1e3e81df94fe6bb4fa8c6afbfe277
+  metadata.gz: 2d2176c440222ba9b1265ce97b575649670c4067da4ddd51529b219ba63d8e15852227843474ae40c8af328d7c366b5ee49f63dac5982c0e1db96157315dd256
+  data.tar.gz: 2dc2d4d16ed22e837e603cd2b7c50a06e3c57d3c5882f47df671ea096aadbab6cae8c0ca50d940f9545d59163fa3034a667d80df84f600900b2c29c7b519dded

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.18.1
+- Add [module function](https://yoshoku.github.io/rumale/doc/Rumale/EvaluationMeasure.html#classification_report-class_method) for generating summary of classification performance.
+- Delete marshal dump and load methods for documentation.
+  The marshal methods are written in estimator classes for indicating on API documentation that the learned model can be saved with Marshal.
+  Even without these methods, Marshal can save the learned model, so they are deleted sequentially.
+  - [Manifold](https://yoshoku.github.io/rumale/doc/Rumale/Manifold.html)
+  - [NaiveBayes](https://yoshoku.github.io/rumale/doc/Rumale/NaiveBayes.html)
+  - [PolynomialModel](https://yoshoku.github.io/rumale/doc/Rumale/PolynomialModel.html)
+  - [Decomposition](https://yoshoku.github.io/doc/Rumale/Decomposition.html)
+
 # 0.18.0
 - Add transformer class for [FisherDiscriminantAnalysis](https://yoshoku.github.io/rumale/doc/Rumale/MetricLearning/FisherDiscriminantAnalysis.html).
 - Add transformer class for [NeighbourhoodComponentAnalysis](https://yoshoku.github.io/rumale/doc/Rumale/MetricLearning/NeighbourhoodComponentAnalysis.html).

data/lib/rumale.rb

@@ -122,3 +122,4 @@ require 'rumale/evaluation_measure/normalized_mutual_information'
 require 'rumale/evaluation_measure/silhouette_score'
 require 'rumale/evaluation_measure/davies_bouldin_score'
 require 'rumale/evaluation_measure/calinski_harabasz_score'
+require 'rumale/evaluation_measure/function'

data/lib/rumale/decomposition/factor_analysis.rb

@@ -128,28 +128,6 @@ module Rumale
         @params[:n_components] == 1 ? z[true, 0].dup : z
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data.
-      def marshal_dump
-        { params: @params,
-          mean: @mean,
-          noise_variance: @noise_variance,
-          components: @components,
-          loglike: @loglike,
-          n_iter: @n_iter }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @mean = obj[:mean]
-        @noise_variance = obj[:noise_variance]
-        @components = obj[:components]
-        @loglike = obj[:loglike]
-        @n_iter = obj[:n_iter]
-      end
-
       private
 
       def log_likelihood(cov_mat, factors, noise_vars)

data/lib/rumale/decomposition/fast_ica.rb

@@ -123,29 +123,6 @@ module Rumale
         x
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data.
-      def marshal_dump
-        { params: @params,
-          components: @components,
-          mixing: @mixing,
-          n_iter: @n_iter,
-          mean: @mean,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @components = obj[:components]
-        @mixing = obj[:mixing]
-        @n_iter = obj[:n_iter]
-        @mean = obj[:mean]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def whitening(x, n_components)

data/lib/rumale/decomposition/nmf.rb

@@ -89,23 +89,6 @@ module Rumale
         z.dot(@components)
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data.
-      def marshal_dump
-        { params: @params,
-          components: @components,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @components = obj[:components]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def partial_fit(x, update_comps = true)

data/lib/rumale/decomposition/pca.rb

@@ -125,25 +125,6 @@ module Rumale
         z.dot(c) + @mean
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data.
-      def marshal_dump
-        { params: @params,
-          components: @components,
-          mean: @mean,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @components = obj[:components]
-        @mean = obj[:mean]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def orthogonalize(pcvec)

data/lib/rumale/evaluation_measure/function.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'rumale/validation'
+require 'rumale/evaluation_measure/accuracy'
+require 'rumale/evaluation_measure/precision_recall'
+
+module Rumale
+  module EvaluationMeasure
+    module_function
+
+    # Output a summary of classification performance for each class.
+    #
+    # @example
+    #   y_true = Numo::Int32[0, 1, 1, 2, 2, 2, 0]
+    #   y_pred = Numo::Int32[1, 1, 1, 0, 0, 2, 0]
+    #   puts Rumale::EvaluationMeasure.classification_report(y_true, y_pred)
+    #
+    #   #               precision    recall  f1-score   support
+    #   #
+    #   #            0       0.33      0.50      0.40         2
+    #   #            1       0.67      1.00      0.80         2
+    #   #            2       1.00      0.33      0.50         3
+    #   #
+    #   #     accuracy                           0.57         7
+    #   #    macro avg       0.67      0.61      0.57         7
+    #   # weighted avg       0.71      0.57      0.56         7
+    #
+    # @param y_true [Numo::Int32] (shape: [n_samples]) The ground truth labels.
+    # @param y_pred [Numo::Int32] (shape: [n_samples]) The predicted labels.
+    # @param target_name [Nil/Array] The label names.
+    # @param output_hash [Boolean] The flag indicating whether to output with Ruby Hash.
+    # @return [String/Hash] The summary of classification performance.
+    #   If output_hash is true, it returns the summary with Ruby Hash.
+    def classification_report(y_true, y_pred, target_name: nil, output_hash: false)
+      y_true = Rumale::Validation.check_convert_label_array(y_true)
+      y_pred = Rumale::Validation.check_convert_label_array(y_pred)
+      # calculate each evaluation measure.
+      supports = y_true.bincount
+      precisions = Rumale::EvaluationMeasure::PrecisionRecall.precision_each_class(y_true, y_pred)
+      recalls = Rumale::EvaluationMeasure::PrecisionRecall.recall_each_class(y_true, y_pred)
+      fscores = Rumale::EvaluationMeasure::PrecisionRecall.f_score_each_class(y_true, y_pred)
+      macro_precision = Rumale::EvaluationMeasure::PrecisionRecall.macro_average_precision(y_true, y_pred)
+      macro_recall = Rumale::EvaluationMeasure::PrecisionRecall.macro_average_recall(y_true, y_pred)
+      macro_fscore = Rumale::EvaluationMeasure::PrecisionRecall.macro_average_f_score(y_true, y_pred)
+      accuracy = Rumale::EvaluationMeasure::Accuracy.new.score(y_true, y_pred)
+      sum_supports = supports.sum
+      weights = Numo::DFloat.cast(supports) / sum_supports
+      weighted_precision = (Numo::DFloat.cast(precisions) * weights).sum
+      weighted_recall = (Numo::DFloat.cast(recalls) * weights).sum
+      weighted_fscore = (Numo::DFloat.cast(fscores) * weights).sum
+      # output reults.
+      target_name ||= y_true.to_a.uniq.sort.map(&:to_s)
+      if output_hash
+        res = {}
+        target_name.each_with_index do |label, n|
+          res[label] = {
+            precision: precisions[n],
+            recall: recalls[n],
+            fscore: fscores[n],
+            support: supports[n]
+          }
+        end
+        res[:accuracy] = accuracy
+        res[:macro_avg] = {
+          precision: macro_precision,
+          recall: macro_recall,
+          fscore: macro_fscore,
+          support: sum_supports
+        }
+        res[:weighted_avg] = {
+          precision: weighted_precision,
+          recall: weighted_recall,
+          fscore: weighted_fscore,
+          support: sum_supports
+        }
+        res
+      else
+        width = ['weighted avg'.size, target_name.map(&:size).max].max
+        res = +''
+        res << "#{' ' * width}  precision    recall  f1-score   support\n"
+        res << "\n"
+        target_name.each_with_index do |label, n|
+          label_str = format("%##{width}s", label)
+          precision_str = format('%#10s', format('%.2f', precisions[n]))
+          recall_str = format('%#10s', format('%.2f', recalls[n]))
+          fscore_str = format('%#10s', format('%.2f', fscores[n]))
+          supports_str = format('%#10s', supports[n])
+          res << "#{label_str} #{precision_str}#{recall_str}#{fscore_str}#{supports_str}\n"
+        end
+        res << "\n"
+        supports_str = format('%#10s', sum_supports)
+        accuracy_str = format('%#30s', format('%.2f', accuracy))
+        res << format("%##{width}s ", 'accuracy')
+        res << "#{accuracy_str}#{supports_str}\n"
+        precision_str = format('%#10s', format('%.2f', macro_precision))
+        recall_str = format('%#10s', format('%.2f', macro_recall))
+        fscore_str = format('%#10s', format('%.2f', macro_fscore))
+        res << format("%##{width}s ", 'macro avg')
+        res << "#{precision_str}#{recall_str}#{fscore_str}#{supports_str}\n"
+        precision_str = format('%#10s', format('%.2f', weighted_precision))
+        recall_str = format('%#10s', format('%.2f', weighted_recall))
+        fscore_str = format('%#10s', format('%.2f', weighted_fscore))
+        res << format("%##{width}s ", 'weighted avg')
+        res << "#{precision_str}#{recall_str}#{fscore_str}#{supports_str}\n"
+        res
+      end
+    end
+  end
+end

data/lib/rumale/manifold/mds.rb

@@ -126,27 +126,6 @@ module Rumale
         @embedding.dup
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data.
-      def marshal_dump
-        { params: @params,
-          embedding: @embedding,
-          stress: @stress,
-          n_iter: @n_iter,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @embedding = obj[:embedding]
-        @stress = obj[:stress]
-        @n_iter = obj[:n_iter]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def init_embedding(x)

data/lib/rumale/manifold/tsne.rb

@@ -126,27 +126,6 @@ module Rumale
         @embedding.dup
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data.
-      def marshal_dump
-        { params: @params,
-          embedding: @embedding,
-          kl_divergence: @kl_divergence,
-          n_iter: @n_iter,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @embedding = obj[:embedding]
-        @kl_divergence = obj[:kl_divergence]
-        @n_iter = obj[:n_iter]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def init_embedding(x)

data/lib/rumale/naive_bayes/naive_bayes.rb

@@ -103,29 +103,6 @@ module Rumale
         end
         Numo::DFloat[*log_likelihoods].transpose
       end
-
-      # Dump marshal data.
-      #
-      # @return [Hash] The marshal data about GaussianNB.
-      def marshal_dump
-        { params: @params,
-          classes: @classes,
-          class_priors: @class_priors,
-          means: @means,
-          variances: @variances }
-      end
-
-      # Load marshal data.
-      #
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @classes = obj[:classes]
-        @class_priors = obj[:class_priors]
-        @means = obj[:means]
-        @variances = obj[:variances]
-        nil
-      end
     end
 
     # MultinomialNB is a class that implements Multinomial Naive Bayes classifier.
@@ -193,27 +170,6 @@ module Rumale
         end
         Numo::DFloat[*log_likelihoods].transpose
       end
-
-      # Dump marshal data.
-      #
-      # @return [Hash] The marshal data about MultinomialNB.
-      def marshal_dump
-        { params: @params,
-          classes: @classes,
-          class_priors: @class_priors,
-          feature_probs: @feature_probs }
-      end
-
-      # Load marshal data.
-      #
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @classes = obj[:classes]
-        @class_priors = obj[:class_priors]
-        @feature_probs = obj[:feature_probs]
-        nil
-      end
     end
 
     # BernoulliNB is a class that implements Bernoulli Naive Bayes classifier.
@@ -289,27 +245,6 @@ module Rumale
         end
         Numo::DFloat[*log_likelihoods].transpose
       end
-
-      # Dump marshal data.
-      #
-      # @return [Hash] The marshal data about BernoulliNB.
-      def marshal_dump
-        { params: @params,
-          classes: @classes,
-          class_priors: @class_priors,
-          feature_probs: @feature_probs }
-      end
-
-      # Load marshal data.
-      #
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @classes = obj[:classes]
-        @class_priors = obj[:class_priors]
-        @feature_probs = obj[:feature_probs]
-        nil
-      end
     end
   end
 end

data/lib/rumale/polynomial_model/factorization_machine_classifier.rb

@@ -171,29 +171,6 @@ module Rumale
         probs
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data about FactorizationMachineClassifier.
-      def marshal_dump
-        { params: @params,
-          factor_mat: @factor_mat,
-          weight_vec: @weight_vec,
-          bias_term: @bias_term,
-          classes: @classes,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @factor_mat = obj[:factor_mat]
-        @weight_vec = obj[:weight_vec]
-        @bias_term = obj[:bias_term]
-        @classes = obj[:classes]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def bin_decision_function(x, ex_x, factor, weight)

data/lib/rumale/polynomial_model/factorization_machine_regressor.rb

@@ -113,27 +113,6 @@ module Rumale
         linear_term + factor_term
       end
 
-      # Dump marshal data.
-      # @return [Hash] The marshal data about FactorizationMachineRegressor.
-      def marshal_dump
-        { params: @params,
-          factor_mat: @factor_mat,
-          weight_vec: @weight_vec,
-          bias_term: @bias_term,
-          rng: @rng }
-      end
-
-      # Load marshal data.
-      # @return [nil]
-      def marshal_load(obj)
-        @params = obj[:params]
-        @factor_mat = obj[:factor_mat]
-        @weight_vec = obj[:weight_vec]
-        @bias_term = obj[:bias_term]
-        @rng = obj[:rng]
-        nil
-      end
-
       private
 
       def loss_func(x, ex_x, y, factor, weight)

data/lib/rumale/version.rb

@@ -3,5 +3,5 @@
 # Rumale is a machine learning library in Ruby.
 module Rumale
   # The version of Rumale you are using.
-  VERSION = '0.18.0'
+  VERSION = '0.18.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumale
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -223,6 +223,7 @@ files:
 - lib/rumale/evaluation_measure/davies_bouldin_score.rb
 - lib/rumale/evaluation_measure/explained_variance_score.rb
 - lib/rumale/evaluation_measure/f_score.rb
+- lib/rumale/evaluation_measure/function.rb
 - lib/rumale/evaluation_measure/log_loss.rb
 - lib/rumale/evaluation_measure/mean_absolute_error.rb
 - lib/rumale/evaluation_measure/mean_squared_error.rb