This repository has been archived by the owner on Nov 19, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2k
/
MultinomialLogisticRegression.cs
582 lines (522 loc) · 21 KB
/
MultinomialLogisticRegression.cs
1
2
3
4
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
// Accord Statistics Library
// The Accord.NET Framework
// http://accord-framework.net
//
// Copyright © César Souza, 2009-2016
// cesarsouza at gmail.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
namespace Accord.Statistics.Models.Regression
{
using System;
using Accord.Math;
using Accord.Statistics.Testing;
using AForge;
using Accord.MachineLearning;
using System.Runtime.Serialization;
/// <summary>
/// Nominal Multinomial Logistic Regression.
/// </summary>
///
/// <example>
/// <code>
/// // Create a new Multinomial Logistic Regression for 3 categories
/// var mlr = new MultinomialLogisticRegression(inputs: 2, categories: 3);
///
/// // Create a estimation algorithm to estimate the regression
/// LowerBoundNewtonRaphson lbnr = new LowerBoundNewtonRaphson(mlr);
///
/// // Now, we will iteratively estimate our model. The Run method returns
/// // the maximum relative change in the model parameters and we will use
/// // it as the convergence criteria.
///
/// double delta;
/// int iteration = 0;
///
/// do
/// {
/// // Perform an iteration
/// delta = lbnr.Run(inputs, outputs);
/// iteration++;
///
/// } while (iteration < 100 && delta > 1e-6);
/// </code>
/// </example>
///
[Serializable]
public class MultinomialLogisticRegression : MulticlassLikelihoodClassifierBase<double[]>,
ICloneable
{
#pragma warning disable 0649
[Obsolete]
private int inputs;
[Obsolete]
private int categories;
#pragma warning restore 0649
private double[][] coefficients;
private double[][] standardErrors;
/// <summary>
/// Creates a new Multinomial Logistic Regression Model.
/// </summary>
///
/// <param name="inputs">The number of input variables for the model.</param>
/// <param name="categories">The number of categories for the model.</param>
///
public MultinomialLogisticRegression(int inputs, int categories)
{
if (inputs < 1)
throw new ArgumentOutOfRangeException("inputs");
if (categories < 1)
throw new ArgumentOutOfRangeException("categories");
this.NumberOfOutputs = categories;
this.NumberOfInputs = inputs;
this.coefficients = new double[categories - 1][];
this.standardErrors = new double[categories - 1][];
for (int i = 0; i < coefficients.Length; i++)
{
coefficients[i] = new double[inputs + 1];
standardErrors[i] = new double[inputs + 1];
}
}
/// <summary>
/// Creates a new Multinomial Logistic Regression Model.
/// </summary>
///
/// <param name="inputs">The number of input variables for the model.</param>
/// <param name="categories">The number of categories for the model.</param>
/// <param name="intercepts">The initial values for the intercepts.</param>
///
public MultinomialLogisticRegression(int inputs, int categories, double[] intercepts)
: this(inputs, categories)
{
for (int i = 0; i < coefficients.Length; i++)
coefficients[i][0] = intercepts[i];
}
/// <summary>
/// Gets the coefficient vectors, in which the
/// first column are the intercept values.
/// </summary>
///
public double[][] Coefficients
{
get { return coefficients; }
set { coefficients = value; }
}
/// <summary>
/// Gets the standard errors associated with each
/// coefficient during the model estimation phase.
/// </summary>
///
public double[][] StandardErrors
{
get { return standardErrors; }
}
/// <summary>
/// Gets the number of categories of the model.
/// </summary>
///
[Obsolete("Please use NumberOfOutputs instead.")]
public int Categories
{
get { return NumberOfOutputs; }
}
/// <summary>
/// Gets the number of inputs of the model.
/// </summary>
[Obsolete("Please use NumberOfInputs instead.")]
public int Inputs
{
get { return NumberOfInputs; }
}
/// <summary>
/// Computes the model output for the given input vector.
/// </summary>
///
/// <remarks>
/// The first category is always considered the baseline category.
/// </remarks>
///
/// <param name="input">The input vector.</param>
///
/// <returns>The output value.</returns>
///
[Obsolete("Please use Probabilities() instead.")]
public double[] Compute(double[] input)
{
return Probabilities(input);
}
/// <summary>
/// Computes the model outputs for the given input vectors.
/// </summary>
///
/// <remarks>
/// The first category is always considered the baseline category.
/// </remarks>
///
/// <param name="input">The input vector.</param>
///
/// <returns>The output value.</returns>
///
[Obsolete("Please use Probabilities() instead.")]
public double[][] Compute(double[][] input)
{
return Probabilities(input);
}
/// <summary>
/// Computes the log-likelihood that the given input vector
/// belongs to the specified <paramref name="classIndex" />.
/// </summary>
/// <param name="input">The input vector.</param>
/// <param name="classIndex">The index of the class whose score will be computed.</param>
/// <returns>System.Double.</returns>
public override double LogLikelihood(double[] input, int classIndex)
{
if (classIndex == 0)
return 0;
// Get category coefficients
double[] c = coefficients[classIndex - 1];
double logit = c[0]; // intercept
for (int i = 0; i < input.Length; i++)
logit += c[i + 1] * input[i];
return logit;
}
/// <summary>
/// Predicts a class label vector for the given input vector, returning the
/// log-likelihoods of the input vector belonging to each possible class.
/// </summary>
/// <param name="input">A set of input vectors.</param>
/// <param name="decision">The class labels associated with each input
/// vector, as predicted by the classifier. If passed as null, the classifier
/// will create a new array.</param>
/// <param name="result">An array where the probabilities will be stored,
/// avoiding unnecessary memory allocations.</param>
/// <returns>System.Double[].</returns>
public override double[] LogLikelihoods(double[] input, out int decision, double[] result)
{
for (int j = 1; j < coefficients.Length; j++)
{
// Get category coefficients
double[] c = coefficients[j - 1];
double logit = c[0]; // intercept
for (int i = 0; i < input.Length; i++)
logit += c[i + 1] * input[i];
result[j] = logit;
}
decision = result.ArgMax();
return result;
}
/// <summary>
/// The likelihood ratio test of the overall model, also called the model chi-square test.
/// </summary>
///
/// <remarks>
/// <para>
/// The Chi-square test, also called the likelihood ratio test or the log-likelihood test
/// is based on the deviance of the model (-2*log-likelihood). The log-likelihood ratio test
/// indicates whether there is evidence of the need to move from a simpler model to a more
/// complicated one (where the simpler model is nested within the complicated one).</para>
/// <para>
/// The difference between the log-likelihood ratios for the researcher's model and a
/// simpler model is often called the "model chi-square".</para>
/// </remarks>
///
public ChiSquareTest ChiSquare(double[][] input, double[][] output)
{
double[] sums = output.Sum(0);
double[] intercept = new double[NumberOfOutputs - 1];
for (int i = 0; i < intercept.Length; i++)
intercept[i] = Math.Log(sums[i + 1] / sums[0]);
var regression = new MultinomialLogisticRegression(NumberOfInputs, NumberOfOutputs, intercept);
double ratio = GetLogLikelihoodRatio(input, output, regression);
return new ChiSquareTest(ratio, (NumberOfInputs) * (NumberOfOutputs - 1));
}
/// <summary>
/// The likelihood ratio test of the overall model, also called the model chi-square test.
/// </summary>
///
/// <remarks>
/// <para>
/// The Chi-square test, also called the likelihood ratio test or the log-likelihood test
/// is based on the deviance of the model (-2*log-likelihood). The log-likelihood ratio test
/// indicates whether there is evidence of the need to move from a simpler model to a more
/// complicated one (where the simpler model is nested within the complicated one).</para>
/// <para>
/// The difference between the log-likelihood ratios for the researcher's model and a
/// simpler model is often called the "model chi-square".</para>
/// </remarks>
///
public ChiSquareTest ChiSquare(double[][] input, int[] classes)
{
return ChiSquare(input, Jagged.OneHot(classes));
}
/// <summary>
/// Gets the 95% confidence interval for the Odds Ratio for a given coefficient.
/// </summary>
///
/// <param name="category">The category's index. </param>
///
/// <param name="coefficient">
/// The coefficient's index. The first value
/// (at zero index) is the intercept value.
/// </param>
///
public DoubleRange GetConfidenceInterval(int category, int coefficient)
{
double coeff = coefficients[category][coefficient];
double error = standardErrors[category][coefficient];
double upper = coeff + 1.9599 * error;
double lower = coeff - 1.9599 * error;
DoubleRange ci = new DoubleRange(Math.Exp(lower), Math.Exp(upper));
return ci;
}
/// <summary>
/// Gets the 95% confidence intervals for the Odds Ratios for all coefficients.
/// </summary>
///
/// <param name="category">The category's index.</param>
///
public DoubleRange[] GetConfidenceInterval(int category)
{
var ranges = new DoubleRange[NumberOfInputs + 1];
for (int i = 0; i < ranges.Length; i++)
ranges[i] = GetConfidenceInterval(category, i);
return ranges;
}
/// <summary>
/// Gets the Odds Ratio for a given coefficient.
/// </summary>
///
/// <remarks>
/// The odds ratio can be computed raising Euler's number
/// (e ~~ 2.71) to the power of the associated coefficient.
/// </remarks>
///
/// <param name="category">The category index.</param>
///
/// <param name="coefficient">
/// The coefficient's index. The first value
/// (at zero index) is the intercept value.
/// </param>
///
/// <returns>
/// The Odds Ratio for the given coefficient.
/// </returns>
///
public double GetOddsRatio(int category, int coefficient)
{
return Math.Exp(coefficients[category][coefficient]);
}
/// <summary>
/// Gets the Odds Ratio for all coefficients.
/// </summary>
///
/// <remarks>
/// The odds ratio can be computed raising Euler's number
/// (e ~~ 2.71) to the power of the associated coefficient.
/// </remarks>
///
/// <param name="category">The category index.</param>
///
/// <returns>
/// The Odds Ratio for the given coefficient.
/// </returns>
///
public double[] GetOddsRatio(int category)
{
var odds = new double[NumberOfInputs + 1];
for (int i = 0; i < odds.Length; i++)
odds[i] = GetOddsRatio(category, i);
return odds;
}
/// <summary>
/// Gets the Wald Test for a given coefficient.
/// </summary>
///
/// <remarks>
/// The Wald statistical test is a test for a model parameter in which
/// the estimated parameter θ is compared with another proposed parameter
/// under the assumption that the difference between them will be approximately
/// normal. There are several problems with the use of the Wald test. Please
/// take a look on substitute tests based on the log-likelihood if possible.
/// </remarks>
///
/// <param name="category">The category index.</param>
///
/// <param name="coefficient">
/// The coefficient's index. The first value
/// (at zero index) is the intercept value.
/// </param>
///
public WaldTest GetWaldTest(int category, int coefficient)
{
return new WaldTest(coefficients[category][coefficient], 0.0, standardErrors[category][coefficient]);
}
/// <summary>
/// Gets the Wald Test for all coefficients.
/// </summary>
///
/// <remarks>
/// The Wald statistical test is a test for a model parameter in which
/// the estimated parameter θ is compared with another proposed parameter
/// under the assumption that the difference between them will be approximately
/// normal. There are several problems with the use of the Wald test. Please
/// take a look on substitute tests based on the log-likelihood if possible.
/// </remarks>
///
/// <param name="category">The category's index.</param>
///
public WaldTest[] GetWaldTest(int category)
{
var tests = new WaldTest[NumberOfInputs + 1];
for (int i = 0; i < tests.Length; i++)
tests[i] = GetWaldTest(category, i);
return tests;
}
/// <summary>
/// Gets the Deviance for the model.
/// </summary>
///
/// <remarks>
/// The deviance is defined as -2*Log-Likelihood.
/// </remarks>
///
/// <param name="input">A set of input data.</param>
/// <param name="output">A set of output data.</param>
/// <returns>
/// The deviance (a measure of performance) of the model
/// calculated over the given data sets.
/// </returns>
///
public double GetDeviance(double[][] input, double[][] output)
{
return -2.0 * GetLogLikelihood(input, output);
}
/// <summary>
/// Gets the Deviance for the model.
/// </summary>
///
/// <remarks>
/// The deviance is defined as -2*Log-Likelihood.
/// </remarks>
///
/// <param name="inputs">A set of input data.</param>
/// <param name="classes">A set of output data.</param>
/// <returns>
/// The deviance (a measure of performance) of the model
/// calculated over the given data sets.
/// </returns>
///
public double GetDeviance(double[][] inputs, int[] classes)
{
return -2.0 * GetLogLikelihood(inputs, classes);
}
/// <summary>
/// Gets the Deviance for the model.
/// </summary>
///
/// <remarks>
/// The deviance is defined as -2*Log-Likelihood.
/// </remarks>
///
/// <param name="inputs">A set of input data.</param>
/// <param name="classes">A set of output data.</param>
/// <returns>
/// The deviance (a measure of performance) of the model
/// calculated over the given data sets.
/// </returns>
///
public double GetLogLikelihood(double[][] inputs, int[] classes)
{
return GetLogLikelihood(inputs, Jagged.OneHot(classes));
}
/// <summary>
/// Gets the Log-Likelihood for the model.
/// </summary>
///
/// <param name="input">A set of input data.</param>
/// <param name="output">A set of output data.</param>
/// <returns>
/// The Log-Likelihood (a measure of performance) of
/// the model calculated over the given data sets.
/// </returns>
///
public double GetLogLikelihood(double[][] input, double[][] output)
{
double sum = 0;
for (int i = 0; i < input.Length; i++)
{
double[] y = Probabilities(input[i]);
double[] o = output[i];
y = y.Multiply(o.Sum());
for (int j = 0; j < y.Length; j++)
{
if (o[j] > 0)
sum += o[j] * (Math.Log(y[j] / o[j]));
Accord.Diagnostics.Debug.Assert(!Double.IsNaN(sum));
}
}
return sum;
}
/// <summary>
/// Gets the Log-Likelihood Ratio between two models.
/// </summary>
///
/// <remarks>
/// The Log-Likelihood ratio is defined as 2*(LL - LL0).
/// </remarks>
///
/// <param name="input">A set of input data.</param>
/// <param name="output">A set of output data.</param>
/// <param name="regression">Another Logistic Regression model.</param>
/// <returns>The Log-Likelihood ratio (a measure of performance
/// between two models) calculated over the given data sets.</returns>
///
public double GetLogLikelihoodRatio(double[][] input, double[][] output, MultinomialLogisticRegression regression)
{
return 2.0 * (this.GetLogLikelihood(input, output) - regression.GetLogLikelihood(input, output));
}
[OnDeserialized]
private void onDeserialized(StreamingContext context)
{
if (NumberOfInputs == 0 && NumberOfOutputs == 0)
{
#pragma warning disable 0618, 0612
NumberOfOutputs = inputs;
NumberOfOutputs = categories;
#pragma warning restore 0618, 0612
}
}
#region ICloneable Members
/// <summary>
/// Creates a new MultinomialLogisticRegression that is a copy of the current instance.
/// </summary>
///
public object Clone()
{
var mlr = new MultinomialLogisticRegression(NumberOfInputs, NumberOfOutputs);
for (int i = 0; i < coefficients.Length; i++)
{
for (int j = 0; j < coefficients[i].Length; j++)
{
mlr.coefficients[i][j] = coefficients[i][j];
mlr.standardErrors[i][j] = standardErrors[i][j];
}
}
return mlr;
}
#endregion
}
}