Class: SVMKit::LinearModel::LogisticRegression

Inherits:
Object
  • Object
show all
Includes:
Base::BaseEstimator, Base::Classifier
Defined in:
lib/svmkit/linear_model/logistic_regression.rb

Overview

LogisticRegression is a class that implements Logistic Regression with stochastic gradient descent (SGD) optimization. For multiclass classification problem, it uses one-vs-the-rest strategy.

Reference

    1. Shalev-Shwartz, Y. Singer, N. Srebro, and A. Cotter, “Pegasos: Primal Estimated sub-GrAdient SOlver for SVM,” Mathematical Programming, vol. 127 (1), pp. 3–30, 2011.

Examples:

estimator =
  SVMKit::LinearModel::LogisticRegression.new(reg_param: 1.0, max_iter: 100, batch_size: 20, random_seed: 1)
estimator.fit(training_samples, traininig_labels)
results = estimator.predict(testing_samples)

Instance Attribute Summary collapse

Attributes included from Base::BaseEstimator

#params

Instance Method Summary collapse

Methods included from Base::Classifier

#score

Constructor Details

#initialize(reg_param: 1.0, fit_bias: false, bias_scale: 1.0, max_iter: 100, batch_size: 50, normalize: true, random_seed: nil) ⇒ LogisticRegression

Create a new classifier with Logisitc Regression by the SGD optimization.

Parameters:

  • reg_param (Float) (defaults to: 1.0) —

    The regularization parameter.

  • fit_bias (Boolean) (defaults to: false) —

    The flag indicating whether to fit the bias term.

  • bias_scale (Float) (defaults to: 1.0) —

    The scale of the bias term. If fit_bias is true, the feature vector v becoms [v; bias_scale].

  • max_iter (Integer) (defaults to: 100) —

    The maximum number of iterations.

  • batch_size (Integer) (defaults to: 50) —

    The size of the mini batches.

  • normalize (Boolean) (defaults to: true) —

    The flag indicating whether to normalize the weight vector.

  • random_seed (Integer) (defaults to: nil) —

    The seed value using to initialize the random generator.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 51

def initialize(reg_param: 1.0, fit_bias: false, bias_scale: 1.0,
               max_iter: 100, batch_size: 50, normalize: true, random_seed: nil)
  SVMKit::Validation.check_params_float(reg_param: reg_param, bias_scale: bias_scale)
  SVMKit::Validation.check_params_integer(max_iter: max_iter, batch_size: batch_size)
  SVMKit::Validation.check_params_boolean(fit_bias: fit_bias, normalize: normalize)
  SVMKit::Validation.check_params_type_or_nil(Integer, random_seed: random_seed)
  SVMKit::Validation.check_params_positive(reg_param: reg_param, bias_scale: bias_scale, max_iter: max_iter,
                                           batch_size: batch_size)
  @params = {}
  @params[:reg_param] = reg_param
  @params[:fit_bias] = fit_bias
  @params[:bias_scale] = bias_scale
  @params[:max_iter] = max_iter
  @params[:batch_size] = batch_size
  @params[:normalize] = normalize
  @params[:random_seed] = random_seed
  @params[:random_seed] ||= srand
  @weight_vec = nil
  @bias_term = nil
  @classes = nil
  @rng = Random.new(@params[:random_seed])
end

Instance Attribute Details

#bias_term ⇒ Numo::DFloat (readonly)

Return the bias term (a.k.a. intercept) for Logistic Regression.

Returns:

  • (Numo::DFloat) —

    (shape: [n_classes])



31
32
33
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 31

def bias_term
  @bias_term
end

#classes ⇒ Numo::Int32 (readonly)

Return the class labels.

Returns:

  • (Numo::Int32) —

    (shape: [n_classes])



35
36
37
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 35

def classes
  @classes
end

#rng ⇒ Random (readonly)

Return the random generator for performing random sampling.

Returns:

  • (Random) 


39
40
41
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 39

def rng
  @rng
end

#weight_vec ⇒ Numo::DFloat (readonly)

Return the weight vector for Logistic Regression.

Returns:

  • (Numo::DFloat) —

    (shape: [n_classes, n_features])



27
28
29
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 27

def weight_vec
  @weight_vec
end

Instance Method Details

#decision_function(x) ⇒ Numo::DFloat

Calculate confidence scores for samples.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The samples to compute the scores.

Returns:

  • (Numo::DFloat) —

    (shape: [n_samples, n_classes]) Confidence score per sample.



110
111
112
113
114
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 110

def decision_function(x)
  SVMKit::Validation.check_sample_array(x)

  x.dot(@weight_vec.transpose) + @bias_term
end

#fit(x, y) ⇒ LogisticRegression

Fit the model with given training data.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The training data to be used for fitting the model.

  • y (Numo::Int32) —

    (shape: [n_samples]) The labels to be used for fitting the model.

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 79

def fit(x, y)
  SVMKit::Validation.check_sample_array(x)
  SVMKit::Validation.check_label_array(y)
  SVMKit::Validation.check_sample_label_size(x, y)

  @classes = Numo::Int32[*y.to_a.uniq.sort]
  n_classes = @classes.size
  _n_samples, n_features = x.shape

  if n_classes > 2
    @weight_vec = Numo::DFloat.zeros(n_classes, n_features)
    @bias_term = Numo::DFloat.zeros(n_classes)
    n_classes.times do |n|
      bin_y = Numo::Int32.cast(y.eq(@classes[n])) * 2 - 1
      weight, bias = binary_fit(x, bin_y)
      @weight_vec[n, true] = weight
      @bias_term[n] = bias
    end
  else
    negative_label = y.to_a.uniq.sort.first
    bin_y = Numo::Int32.cast(y.ne(negative_label)) * 2 - 1
    @weight_vec, @bias_term = binary_fit(x, bin_y)
  end

  self
end

#marshal_dump ⇒ Hash

Dump marshal data.

Returns:

  • (Hash) —

    The marshal data about LogisticRegression.



149
150
151
152
153
154
155
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 149

def marshal_dump
  { params: @params,
    weight_vec: @weight_vec,
    bias_term: @bias_term,
    classes: @classes,
    rng: @rng }
end

#marshal_load(obj) ⇒ nil

Load marshal data.

Returns:

  • (nil) 


159
160
161
162
163
164
165
166
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 159

def marshal_load(obj)
  @params = obj[:params]
  @weight_vec = obj[:weight_vec]
  @bias_term = obj[:bias_term]
  @classes = obj[:classes]
  @rng = obj[:rng]
  nil
end

#predict(x) ⇒ Numo::Int32

Predict class labels for samples.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The samples to predict the labels.

Returns:

  • (Numo::Int32) —

    (shape: [n_samples]) Predicted class label per sample.



120
121
122
123
124
125
126
127
128
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 120

def predict(x)
  SVMKit::Validation.check_sample_array(x)

  return Numo::Int32.cast(predict_proba(x)[true, 1].ge(0.5)) * 2 - 1 if @classes.size <= 2

  n_samples, = x.shape
  decision_values = predict_proba(x)
  Numo::Int32.asarray(Array.new(n_samples) { |n| @classes[decision_values[n, true].max_index] })
end

#predict_proba(x) ⇒ Numo::DFloat

Predict probability for samples.

Parameters:

  • x (Numo::DFloat) —

    (shape: [n_samples, n_features]) The samples to predict the probailities.

Returns:

  • (Numo::DFloat) —

    (shape: [n_samples, n_classes]) Predicted probability of each class per sample.



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/svmkit/linear_model/logistic_regression.rb', line 134

def predict_proba(x)
  SVMKit::Validation.check_sample_array(x)

  proba = 1.0 / (Numo::NMath.exp(-decision_function(x)) + 1.0)
  return (proba.transpose / proba.sum(axis: 1)).transpose if @classes.size > 2

  n_samples, = x.shape
  probs = Numo::DFloat.zeros(n_samples, 2)
  probs[true, 1] = proba
  probs[true, 0] = 1.0 - proba
  probs
end