From da9a0197139c9349bd9650e6dbdace91171ee6a3 Mon Sep 17 00:00:00 2001 From: Sepand Haghighi Date: Sat, 28 Dec 2024 22:17:58 +0330 Subject: [PATCH] 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 | 18 +++++++++--------- CHANGELOG.md | 3 +++ Document/Distance.ipynb | 10 +++++----- README.md | 3 ++- pycm/distance.py | 2 +- 5 files changed, 20 insertions(+), 16 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index 59fcb36e..ad02f361 100644 --- a/AUTHORS.md +++ b/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) diff --git a/CHANGELOG.md b/CHANGELOG.md index 094f924f..0efe25c9 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/Document/Distance.ipynb b/Document/Distance.ipynb index 2336aee9..6393fb98 100644 --- a/Document/Distance.ipynb +++ b/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, diff --git a/README.md b/README.md index 68398939..431392aa 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,10 @@

PyCM: Python Confusion Matrix


built with Python3 +GitHub repo size -PyPI version +PyPI version Document Discord Channel diff --git a/pycm/distance.py b/pycm/distance.py index dc431845..dbe231a8 100644 --- a/pycm/distance.py +++ b/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