Minor edits (#584)

* doc : n --> N

* doc : KuhnsVII_calc docstring updated

* doc : AUTHORS.md updated

* doc : pypi badge height bug fixed

* doc : repo-size badge added

* doc : CHANGELOG.md updated

* doc : CHANGELOG.md updated

AUTHORS.md

@@ -1,5 +1,4 @@
-# Authors
-
+# Core Developers
 ----------
 - Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi)) **
 - Alireza Zolanvari  - Open Science Laboratory ([Github](https://github.com/AlirezaZolanvari)) **
@@ -11,10 +10,11 @@
 
 # Other Contributors
 ----------
-- [Sohee Yang](https://github.com/soheeyang)
-- [Mohammad Mahdi Rahimi](https://github.com/mahi97)
-- [Christian Clauss](https://github.com/cclauss)
-- [Negar Zabetian](https://github.com/negarzabetian)
-- [Ashwin Geet D'Sa](https://github.com/GeetDsa)
-- [Ilya Gubins](https://github.com/the-lay)
-- [Lewi Uberg](https://github.com/lewiuberg)
+- [@soheeyang](https://github.com/soheeyang)
+- [@mahi97](https://github.com/mahi97)
+- [@cclauss](https://github.com/cclauss)
+- [@negarzabetian](https://github.com/negarzabetian)
+- [@GeetDsa](https://github.com/GeetDsa)
+- [@the-lay](https://github.com/the-lay)
+- [@lewiuberg](https://github.com/lewiuberg)
+- [@AHReccese](https://github.com/AHReccese)

CHANGELOG.md

@@ -15,6 +15,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 - PyPI badge in `README.md`
 - GitHub actions are limited to the `dev` and `master` branches
+- `AUTHORS.md` updated
+- `README.md` modified
+- Document modified
 ## [4.1] - 2024-10-17
 ### Added
 - 5 new distance/similarity

Document/Distance.ipynb

@@ -3065,7 +3065,7 @@
    "source": [
     "$$corr_{KuhnsIII} =\n",
     "\\frac{\\delta(TP + FP, TP + FN)}\n",
-    "{(1-\\frac{TP}{2 \\times TP + FP + FN})(2 \\times TP + FP + FN-\\frac{(TP + FP)(TP + FN)}{n})}\n",
+    "{(1-\\frac{TP}{2 \\times TP + FP + FN})(2 \\times TP + FP + FN-\\frac{(TP + FP)(TP + FN)}{N})}\n",
     "$$\n",
     "\n",
     "$$\n",
@@ -3179,7 +3179,7 @@
    "source": [
     "$$corr_{KuhnsV} =\n",
     "\\frac{\\delta(TP + FP, TP + FN)}\n",
-    "{\\max((TP+FP)(1-\\frac{TP+FP}{n}), (TP+FN)(1-\\frac{TP+FN}{n}))}\n",
+    "{\\max((TP+FP)(1-\\frac{TP+FP}{N}), (TP+FN)(1-\\frac{TP+FN}{N}))}\n",
     "$$\n",
     "\n",
     "$$\n",
@@ -3236,7 +3236,7 @@
    "source": [
     "$$corr_{KuhnsVI} =\n",
     "\\frac{\\delta(TP + FP, TP + FN)}\n",
-    "{\\min((TP+FP)(1-\\frac{TP+FP}{n}), (TP+FN)(1-\\frac{TP+FN}{n}))}\n",
+    "{\\min((TP+FP)(1-\\frac{TP+FP}{N}), (TP+FN)(1-\\frac{TP+FN}{N}))}\n",
     "$$\n",
     "\n",
     "$$\n",
@@ -3425,7 +3425,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -3439,7 +3439,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.5.2"
   },
   "toc": {
    "base_numbering": 1,

README.md

@@ -3,9 +3,10 @@
 <h1>PyCM: Python Confusion Matrix</h1>
 <br/>
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+<a href="https://github.com/sepandhaghighi/pycm"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/sepandhaghighi/pycm"></a>
 <a href="/Document"><img src="https://img.shields.io/badge/doc-latest-orange.svg"></a>
 <a href="https://codecov.io/gh/sepandhaghighi/pycm"><img src="https://codecov.io/gh/sepandhaghighi/pycm/branch/master/graph/badge.svg"></a>
-<a href="https://badge.fury.io/py/pycm"><img src="https://badge.fury.io/py/pycm.svg" alt="PyPI version" height="18"></a>
+<a href="https://badge.fury.io/py/pycm"><img src="https://badge.fury.io/py/pycm.svg" alt="PyPI version"></a>
 <a href="https://anaconda.org/sepandhaghighi/pycm"><img src="https://anaconda.org/sepandhaghighi/pycm/badges/version.svg"></a>
 <a href="https://colab.research.google.com/github/sepandhaghighi/pycm/blob/master"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Document"></a>
 <a href="https://discord.com/invite/zqpU2b3J3f"><img src="https://img.shields.io/discord/901883546162065408.svg" alt="Discord Channel"></a>

pycm/distance.py

@@ -1448,7 +1448,7 @@ def KuhnsVII_calc(TP, FP, FN, TN):
     :type FP: int
     :param FN: false negative
     :type FN: int
-    :return: Kuhns VI correlation as float
+    :return: Kuhns VII correlation as float
     """
     try:
         n = TP + FP + FN + TN