Skip to content

Commit 52106b7

Browse files
thieu1995thieu1995
committed
Update docs and readme
1 parent d62fda5 commit 52106b7

File tree

6 files changed

+145
-141
lines changed

6 files changed

+145
-141
lines changed

‎.github/assets/metric_names.xlsx

131 Bytes
Binary file not shown.

‎ChangeLog.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
+ Remove all lowercase shortname of all metrics
33
+ Fix bugs in GINI function belongs to ClassificationMetric
44
+ Fix bugs in some functions belong to ClusteringMetric
5+
+ Update characteristics of most of the functions (valid ranges and best value)
56
+ Add metrics to ClusteringMetrics
67
+ Entropy Score (ES)
78
+ Purity Score (PuS)
@@ -12,7 +13,7 @@
1213
+ R-Squared Index (RSI)
1314
+ Density-Based Clustering Validation Index (DBCVI)
1415
+ Hartigan Index (HI)
15-
+ Update characteristics of most of the functions (valid ranges and best value)
16+
+ Add get_support() method in RegressionMetric, ClassificationMetric, and ClusteringMetric
1617
+ Update and add more examples to all classes.
1718
+ Update documents for all metrics.
1819

‎README.md

+2-1
Large diffs are not rendered by default.

‎docs/source/pages/classification.rst

+17-17
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@ Classification Metrics
22
======================
33

44
+-----+---------+----------------------------------+-----------------------------------------------------+
5-
| STT | Metric | Metric Fullname | Characteristics |
5+
| STT | Metric | Metric Fullname | Characteristics |
66
+=====+=========+==================================+=====================================================+
7-
| 1 | PS | Precision Score | Higher is better (Best = 1), Range = [0, 1] |
7+
| 1 | PS | Precision Score | Bigger is better (Best = 1), Range = [0, 1] |
88
+-----+---------+----------------------------------+-----------------------------------------------------+
9-
| 2 | NPV | Negative Predictive Value | Higher is better (Best = 1), Range = [0, 1] |
9+
| 2 | NPV | Negative Predictive Value | Bigger is better (Best = 1), Range = [0, 1] |
1010
+-----+---------+----------------------------------+-----------------------------------------------------+
11-
| 3 | RS | Recall Score | Higher is better (Best = 1), Range = [0, 1] |
11+
| 3 | RS | Recall Score | Bigger is better (Best = 1), Range = [0, 1] |
1212
+-----+---------+----------------------------------+-----------------------------------------------------+
13-
| 4 | AS | Accuracy Score | Higher is better (Best = 1), Range = [0, 1] |
13+
| 4 | AS | Accuracy Score | Bigger is better (Best = 1), Range = [0, 1] |
1414
+-----+---------+----------------------------------+-----------------------------------------------------+
15-
| 5 | F1S | F1 Score | Higher is better (Best = 1), Range = [0, 1] |
15+
| 5 | F1S | F1 Score | Bigger is better (Best = 1), Range = [0, 1] |
1616
+-----+---------+----------------------------------+-----------------------------------------------------+
17-
| 6 | F2S | F2 Score | Higher is better (Best = 1), Range = [0, 1] |
17+
| 6 | F2S | F2 Score | Bigger is better (Best = 1), Range = [0, 1] |
1818
+-----+---------+----------------------------------+-----------------------------------------------------+
19-
| 7 | FBS | F-Beta Score | Higher is better (Best = 1), Range = [0, 1] |
19+
| 7 | FBS | F-Beta Score | Bigger is better (Best = 1), Range = [0, 1] |
2020
+-----+---------+----------------------------------+-----------------------------------------------------+
21-
| 8 | SS | Specificity Score | Higher is better (Best = 1), Range = [0, 1] |
21+
| 8 | SS | Specificity Score | Bigger is better (Best = 1), Range = [0, 1] |
2222
+-----+---------+----------------------------------+-----------------------------------------------------+
23-
| 9 | MCC | Matthews Correlation Coefficient | Higher is better (Best = 1), Range = [-1, +1] |
23+
| 9 | MCC | Matthews Correlation Coefficient | Bigger is better (Best = 1), Range = [-1, +1] |
2424
+-----+---------+----------------------------------+-----------------------------------------------------+
25-
| 10 | HS | Hamming Score | Higher is better (Best = 1), Range = [0, 1] |
25+
| 10 | HS | Hamming Score | Bigger is better (Best = 1), Range = [0, 1] |
2626
+-----+---------+----------------------------------+-----------------------------------------------------+
27-
| 11 | CKS | Cohen's kappa score | Higher is better (Best = +1), Range = [-1, +1] |
27+
| 11 | CKS | Cohen's kappa score | Bigger is better (Best = +1), Range = [-1, +1] |
2828
+-----+---------+----------------------------------+-----------------------------------------------------+
29-
| 12 | JSI | Jaccard Similarity Coefficient | Higher is better (Best = +1), Range = [0, +1] |
29+
| 12 | JSI | Jaccard Similarity Coefficient | Bigger is better (Best = +1), Range = [0, +1] |
3030
+-----+---------+----------------------------------+-----------------------------------------------------+
31-
| 13 | GMS | Geometric Mean Score | Higher is better (Best = +1), Range = [0, +1] |
31+
| 13 | GMS | Geometric Mean Score | Bigger is better (Best = +1), Range = [0, +1] |
3232
+-----+---------+----------------------------------+-----------------------------------------------------+
33-
| 14 | ROC-AUC | ROC-AUC | Higher is better (Best = +1), Range = [0, +1] |
33+
| 14 | ROC-AUC | ROC-AUC | Bigger is better (Best = +1), Range = [0, +1] |
3434
+-----+---------+----------------------------------+-----------------------------------------------------+
35-
| 15 | LS | Lift Score | Higher is better (No best value), Range = [0, +inf) |
35+
| 15 | LS | Lift Score | Bigger is better (No best value), Range = [0, +inf) |
3636
+-----+---------+----------------------------------+-----------------------------------------------------+
37-
| 16 | GINI | GINI Index | Smaller is better (Best = 0), Range = [0, +1] |
37+
| 16 | GINI | GINI Index | Smaller is better (Best = 0), Range = [0, +1] |
3838
+-----+---------+----------------------------------+-----------------------------------------------------+
3939

4040

‎docs/source/pages/clustering.rst

+25-25
Original file line numberDiff line numberDiff line change
@@ -32,57 +32,57 @@ Clustering Metrics
3232
+-----+--------+-------------------------------------------+--------------------------------------------------------+
3333
| 14 | BI | Beale Index | Smaller is better (Best = 0), Range = [0, +inf) |
3434
+-----+--------+-------------------------------------------+--------------------------------------------------------+
35-
| 15 | RSI | R-squared Index | Higher is better (Best=1), Range = (-inf, 1] |
35+
| 15 | RSI | R-squared Index | Bigger is better (Best=1), Range = (-inf, 1] |
3636
+-----+--------+-------------------------------------------+--------------------------------------------------------+
37-
| 16 | DBCVI | Density-based Clustering Validation Index | Lower is better (Best=0), Range = [0, 1] |
37+
| 16 | DBCVI | Density-based Clustering Validation Index | Bigger is better (Best=0), Range = [0, 1] |
3838
+-----+--------+-------------------------------------------+--------------------------------------------------------+
39-
| 17 | HI | Hartigan Index | Lower is better (best=0), Range = [0, +inf) |
39+
| 17 | HI | Hartigan Index | Bigger is better (best=0), Range = [0, +inf) |
4040
+-----+--------+-------------------------------------------+--------------------------------------------------------+
41-
| 18 | MIS | Mutual Info Score | Higher is better (No best value), Range = [0, +inf) |
41+
| 18 | MIS | Mutual Info Score | Bigger is better (No best value), Range = [0, +inf) |
4242
+-----+--------+-------------------------------------------+--------------------------------------------------------+
43-
| 19 | NMIS | Normalized Mutual Info Score | Higher is better (Best = 1), Range = [0, 1] |
43+
| 19 | NMIS | Normalized Mutual Info Score | Bigger is better (Best = 1), Range = [0, 1] |
4444
+-----+--------+-------------------------------------------+--------------------------------------------------------+
45-
| 20 | RaS | Rand Score | Higher is better (Best = 1), Range = [0, 1] |
45+
| 20 | RaS | Rand Score | Bigger is better (Best = 1), Range = [0, 1] |
4646
+-----+--------+-------------------------------------------+--------------------------------------------------------+
47-
| 21 | FMS | Fowlkes Mallows Score | Higher is better (Best = 1), Range = [0, 1] |
47+
| 21 | FMS | Fowlkes Mallows Score | Bigger is better (Best = 1), Range = [0, 1] |
4848
+-----+--------+-------------------------------------------+--------------------------------------------------------+
49-
| 22 | HS | Homogeneity Score | Higher is better (Best = 1), Range = [0, 1] |
49+
| 22 | HS | Homogeneity Score | Bigger is better (Best = 1), Range = [0, 1] |
5050
+-----+--------+-------------------------------------------+--------------------------------------------------------+
51-
| 23 | CS | Completeness Score | Higher is better (Best = 1), Range = [0, 1] |
51+
| 23 | CS | Completeness Score | Bigger is better (Best = 1), Range = [0, 1] |
5252
+-----+--------+-------------------------------------------+--------------------------------------------------------+
53-
| 24 | VMS | V-Measure Score | Higher is better (Best = 1), Range = [0, 1] |
53+
| 24 | VMS | V-Measure Score | Bigger is better (Best = 1), Range = [0, 1] |
5454
+-----+--------+-------------------------------------------+--------------------------------------------------------+
55-
| 25 | PrS | Precision Score | Higher is better (Best = 1), Range = [0, 1] |
55+
| 25 | PrS | Precision Score | Bigger is better (Best = 1), Range = [0, 1] |
5656
+-----+--------+-------------------------------------------+--------------------------------------------------------+
57-
| 26 | ReS | Recall Score | Higher is better (Best = 1), Range = [0, 1] |
57+
| 26 | ReS | Recall Score | Bigger is better (Best = 1), Range = [0, 1] |
5858
+-----+--------+-------------------------------------------+--------------------------------------------------------+
59-
| 27 | FmS | F-Measure Score | Higher is better (Best = 1), Range = [0, 1] |
59+
| 27 | FmS | F-Measure Score | Bigger is better (Best = 1), Range = [0, 1] |
6060
+-----+--------+-------------------------------------------+--------------------------------------------------------+
61-
| 28 | CDS | Czekanowski Dice Score | Higher is better (Best = 1), Range = [0, 1] |
61+
| 28 | CDS | Czekanowski Dice Score | Bigger is better (Best = 1), Range = [0, 1] |
6262
+-----+--------+-------------------------------------------+--------------------------------------------------------+
63-
| 29 | HGS | Hubert Gamma Score | Higher is better (Best = 1), Range=[-1, +1] |
63+
| 29 | HGS | Hubert Gamma Score | Bigger is better (Best = 1), Range=[-1, +1] |
6464
+-----+--------+-------------------------------------------+--------------------------------------------------------+
65-
| 30 | JS | Jaccard Score | Higher is better (Best = 1), Range = [0, 1] |
65+
| 30 | JS | Jaccard Score | Bigger is better (Best = 1), Range = [0, 1] |
6666
+-----+--------+-------------------------------------------+--------------------------------------------------------+
67-
| 31 | KS | Kulczynski Score | Higher is better (Best = 1), Range = [0, 1] |
67+
| 31 | KS | Kulczynski Score | Bigger is better (Best = 1), Range = [0, 1] |
6868
+-----+--------+-------------------------------------------+--------------------------------------------------------+
69-
| 32 | MNS | Mc Nemar Score | Higher is better (No best value), Range=(-inf, +inf) |
69+
| 32 | MNS | Mc Nemar Score | Bigger is better (No best value), Range=(-inf, +inf) |
7070
+-----+--------+-------------------------------------------+--------------------------------------------------------+
71-
| 33 | PhS | Phi Score | Higher is better (No best value), Range = (-inf, +inf) |
71+
| 33 | PhS | Phi Score | Bigger is better (No best value), Range = (-inf, +inf) |
7272
+-----+--------+-------------------------------------------+--------------------------------------------------------+
73-
| 34 | RTS | Rogers Tanimoto Score | Higher is better (Best = 1), Range = [0, 1] |
73+
| 34 | RTS | Rogers Tanimoto Score | Bigger is better (Best = 1), Range = [0, 1] |
7474
+-----+--------+-------------------------------------------+--------------------------------------------------------+
75-
| 35 | RRS | Russel Rao Score | Higher is better (Best = 1), Range = [0, 1] |
75+
| 35 | RRS | Russel Rao Score | Bigger is better (Best = 1), Range = [0, 1] |
7676
+-----+--------+-------------------------------------------+--------------------------------------------------------+
77-
| 36 | SS1S | Sokal Sneath1 Score | Higher is better (Best = 1), Range = [0, 1] |
77+
| 36 | SS1S | Sokal Sneath1 Score | Bigger is better (Best = 1), Range = [0, 1] |
7878
+-----+--------+-------------------------------------------+--------------------------------------------------------+
79-
| 37 | SS2S | Sokal Sneath2 Score | Higher is better (Best = 1), Range = [0, 1] |
79+
| 37 | SS2S | Sokal Sneath2 Score | Bigger is better (Best = 1), Range = [0, 1] |
8080
+-----+--------+-------------------------------------------+--------------------------------------------------------+
81-
| 38 | PuS | Purity Score | Higher is better (Best = 1), Range = [0, 1] |
81+
| 38 | PuS | Purity Score | Bigger is better (Best = 1), Range = [0, 1] |
8282
+-----+--------+-------------------------------------------+--------------------------------------------------------+
8383
| 39 | ES | Entropy Score | Smaller is better (Best = 0), Range = [0, 1] |
8484
+-----+--------+-------------------------------------------+--------------------------------------------------------+
85-
| 40 | TS | Tau Score | Higher is better (Best = 1), Range = [-1, 1] |
85+
| 40 | TS | Tau Score | Bigger is better (Best = 1), Range = [-1, 1] |
8686
+-----+--------+-------------------------------------------+--------------------------------------------------------+
8787

8888

0 commit comments

Comments
 (0)