confusion_matrix 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc3f9ed40d45bb892541c4a3dc97c04c5893e335ec79b2526d072d291d08a7b7
-  data.tar.gz: 602f9857a4e45283357117974943d46f4802fbd9c5ce7b1be0ec704472d29ba4
+  metadata.gz: 7c054f9ff8a3aed4fc0cef535cb2506aec2d1928ac5b944ec1d6687f6691fce1
+  data.tar.gz: 56a11a2175d65f9a54dc8041f7b7f974abb6e63b3d201b6ed9d81f76b6957765
 SHA512:
-  metadata.gz: 20cc86e92c2ad0867206ee2c2a46fe31de7c08c15e90491d481a8c40fd94541b4dea87b575792652cedbb49fea284e70e4f72250ab6f2e83de2e9b57ea7136c6
-  data.tar.gz: 972386c261254d2fc44b09f320d48b41639c09682f16c0ddeb88cd2697b683f7b178d257e7edcb3bcba51d0dfc4c625bf478fcadd1a6e2e81ed8354a588266ce
+  metadata.gz: 9003d2e3f983cf3403680384ea1addc416e518afec979f3def0913ad60d51b760627eaefd8d52459723683042fc3cf57b120e624c95d023e0e87dbb2022f7ad6
+  data.tar.gz: 8c218ba99d31d456934fbbb0ae866b703503388f3a668f4d89eb2f05a380bda77f820c0b4b08e253f8ae6eca4e16e7857f6735717d9c06cd0a5ec29dd4ca49d8

data/LICENSE.rdoc

@@ -1,22 +1,22 @@
-= MIT License
-
-Copyright (c) 2020-23, Peter Lane
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+= MIT License
+
+Copyright (c) 2020-23, Peter Lane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.rdoc

@@ -1,88 +1,88 @@
-= Confusion Matrix
-
-Install from {RubyGems}[https://rubygems.org/gems/confusion_matrix/]:
-
-  > gem install confusion_matrix
-
-source:: https://notabug.org/peterlane/confusion-matrix-ruby/
-
-== Description
-
-A confusion matrix is used in data-mining as a summary of the performance of a
-classification algorithm. Each row represents the _actual_ class of an
-instance, and each column represents the _predicted_ class of that instance,
-i.e. the class that they were classified as.  Numbers at each (row, column)
-reflect the total number of instances of actual class "row" which were
-predicted to fall in class "column".
-
-A two-class example is:
-
-    Classified      Classified    | 
-    Positive        Negative      | Actual
-    ------------------------------+------------
-        a               b         | Positive
-        c               d         | Negative
-
-Here the value:
-
-a:: is the number of true positives (those labelled positive and classified positive)
-b:: is the number of false negatives (those labelled positive but classified negative)
-c:: is the number of false positives (those labelled negative but classified positive)
-d:: is the number of true negatives (those labelled negative and classified negative)
-
-From this table we can calculate statistics like:
-
-true_positive_rate:: a/(a+b)
-positive recall:: a/(a+c)
-
-The implementation supports confusion matrices with more than two 
-classes, and hence most statistics are calculated with reference to a 
-named class. When more than two classes are in use, the statistics 
-are calculated as if the named class were positive and all the other 
-classes are grouped as if negative.
-
-For example, in a three-class example:
-
-    Classified      Classified    Classified    | 
-       Red            Blue          Green       | Actual
-    --------------------------------------------+------------
-        a               b             c         | Red
-        d               e             f         | Blue
-        g               h             i         | Green
-
-We can calculate:
-
-true_red_rate:: a/(a+b+c)
-red recall:: a/(a+d+g)
-
-== Example
-
-The following example creates a simple two-class confusion matrix, 
-prints a few statistics and displays the table.
-
-    require 'confusion_matrix'
-
-    cm = ConfusionMatrix.new :pos, :neg
-    cm.add_for(:pos, :pos, 10)
-    3.times { cm.add_for(:pos, :neg) }
-    20.times { cm.add_for(:neg, :neg) }
-    5.times { cm.add_for(:neg, :pos) }
-
-    puts "Precision: #{cm.precision}"
-    puts "Recall: #{cm.recall}"
-    puts "MCC: #{cm.matthews_correlation}"
-    puts
-    puts(cm.to_s)
-
-Output:
-
-    Precision: 0.6666666666666666
-    Recall: 0.7692307692307693
-    MCC: 0.5524850114241865
-    
-    Predicted |
-    pos neg   | Actual
-    ----------+-------
-     10   3   | pos
-      5  20   | neg
-
+= Confusion Matrix
+
+Available from:
+- RubyGems: https://rubygems.org/gems/confusion_matrix/
+- Source: https://codeberg.org/peterlane/confusion-matrix/
+
+== Description
+
+A confusion matrix represents "the relative frequencies with which each of a
+number of stimuli is mistaken for each of the others by a person in a task
+requiring recognition or identification of stimuli" (R. Colman, 
+<i>A Dictionary of Psychology</i>, 2008). Each row represents the predicted label of an instance, and
+each column represents the observed label of that instance. Numbers at each
+(row, column) reflect the total number of instances of predicted label "row"
+which were observed as having label "column".
+
+A two-label example is:
+
+    Observed        Observed      | 
+    Positive        Negative      | Predicted
+    ------------------------------+------------
+        a               b         | Positive
+        c               d         | Negative
+
+Here the value:
+
+a:: is the number of true positives (those predicted positive and observed positive)
+b:: is the number of false negatives (those predicted positive but observed negative)
+c:: is the number of false positives (those predicted negative but observed positive)
+d:: is the number of true negatives (those predicted negative and observed negative)
+
+From this matrix we can calculate statistics like:
+
+true positive rate:: a/(a+b)
+positive recall:: a/(a+c)
+
+The implementation supports confusion matrices with more than two 
+labels, and hence most statistics are calculated with reference to a 
+named label. When more than two labels are in use, the statistics 
+are calculated as if the named label were positive and all the other 
+labels are grouped as if negative.
+
+For example, in a three-label example:
+
+     Observed        Observed      Observed     | 
+       Red            Blue          Green       | Predicted
+    --------------------------------------------+------------
+        a               b             c         | Red
+        d               e             f         | Blue
+        g               h             i         | Green
+
+We can calculate:
+
+true red rate:: a/(a+b+c)
+red recall:: a/(a+d+g)
+
+== Example
+
+The following example creates a two-label confusion matrix, 
+prints a few statistics and displays the matrix as a table.
+
+    require 'confusion_matrix'
+
+    cm = ConfusionMatrix.new :pos, :neg
+    cm.add_for(:pos, :pos, 10)
+    3.times { cm.add_for(:pos, :neg) }
+    20.times { cm.add_for(:neg, :neg) }
+    5.times { cm.add_for(:neg, :pos) }
+
+    puts "Precision: #{cm.precision}"
+    puts "Recall: #{cm.recall}"
+    puts "MCC: #{cm.matthews_correlation}"
+    puts
+    puts(cm.to_s)
+
+Output:
+
+    Precision: 0.6666666666666666
+    Recall: 0.7692307692307693
+    MCC: 0.5524850114241865
+    
+    Observed |
+    pos neg  | Predicted
+    ---------+----------
+     10   3  | pos
+      5  20  | neg
+
+