Skip to content

Commit 6183fab

Browse files
pulkkinspulkkins
committed
Documentation fixes
1 parent d1c7d89 commit 6183fab

File tree

2 files changed

+52
-52
lines changed

2 files changed

+52
-52
lines changed

‎pysteps/verification/detcatscores.py

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,40 @@ def scores_det_cat_fcst(pred, obs, thr, scores):
77
88
Parameters
99
----------
10-
pred: array-like
10+
pred : array_like
1111
predictions
12-
obs: array-like
13-
verifiyinig observations
12+
obs : array_like
13+
verifying observations
1414
scores : list
1515
a list containing the names of the scores to be computed, the full list
1616
is:
1717
18-
+------------+--------------------------------------------------------------+
19-
| Name | Description |
20-
+============+==============================================================+
21-
| ACC | accuracy (proportion correct) |
22-
+------------+--------------------------------------------------------------+
23-
| BIAS | frequency bias |
24-
+------------+--------------------------------------------------------------+
25-
| CSI | critical success indey (threat score) |
26-
+------------+--------------------------------------------------------------+
27-
| FA | false alarm rate (prob. of false detection) |
28-
+------------+--------------------------------------------------------------+
29-
| FAR | false alarm ratio |
30-
+------------+--------------------------------------------------------------+
31-
| GSS | Gilber skill score (equitable threat score) |
32-
+------------+--------------------------------------------------------------+
33-
| HK | Hanssen-Kuipers discriminant (Pierce skill score) |
34-
+------------+--------------------------------------------------------------+
35-
| HSS | Heidke skill score |
36-
+------------+--------------------------------------------------------------+
37-
| POD | probability of detection (hit rate) |
38-
+------------+--------------------------------------------------------------+
39-
| SEDI | linear regression slope (conditional bias) |
40-
+------------+--------------------------------------------------------------+
18+
+------------+--------------------------------------------------------------+
19+
| Name | Description |
20+
+============+==============================================================+
21+
| ACC | accuracy (proportion correct) |
22+
+------------+--------------------------------------------------------------+
23+
| BIAS | frequency bias |
24+
+------------+--------------------------------------------------------------+
25+
| CSI | critical success indey (threat score) |
26+
+------------+--------------------------------------------------------------+
27+
| FA | false alarm rate (prob. of false detection) |
28+
+------------+--------------------------------------------------------------+
29+
| FAR | false alarm ratio |
30+
+------------+--------------------------------------------------------------+
31+
| GSS | Gilbert skill score (equitable threat score) |
32+
+------------+--------------------------------------------------------------+
33+
| HK | Hanssen-Kuipers discriminant (Pierce skill score) |
34+
+------------+--------------------------------------------------------------+
35+
| HSS | Heidke skill score |
36+
+------------+--------------------------------------------------------------+
37+
| POD | probability of detection (hit rate) |
38+
+------------+--------------------------------------------------------------+
39+
| SEDI | linear regression slope (conditional bias) |
40+
+------------+--------------------------------------------------------------+
4141
42-
Return:
43-
------
42+
Returns
43+
-------
4444
result : list
4545
the verification results
4646

‎pysteps/verification/detcontscores.py

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,35 @@ def scores_det_cont_fcst(pred, obs, scores, offset=0.01):
88
99
Parameters
1010
----------
11-
pred: array-like
11+
pred : array_like
1212
predictions
13-
obs: array-like
14-
verifiyinig observations
13+
obs : array_like
14+
verifying observations
1515
scores : list
1616
a list containing the names of the scores to be computed, the full list
1717
is:
1818
19-
+------------+--------------------------------------------------------------+
20-
| Name | Description |
21-
+============+==============================================================+
22-
| beta | linear regression slope (conditional bias) |
23-
+------------+--------------------------------------------------------------+
24-
| corr_p | pearson's correleation coefficien (linear correlation) |
25-
+------------+--------------------------------------------------------------+
26-
| corr_s | spearman's correlation coefficient (rank correlation) |
27-
+------------+--------------------------------------------------------------+
28-
| ME_add | mean error or bias of additive residuals |
29-
+------------+--------------------------------------------------------------+
30-
| ME_mult | mean error or bias of multiplicative residuals |
31-
+------------+--------------------------------------------------------------+
32-
| RMSE_add | root mean squared additive error |
33-
+------------+--------------------------------------------------------------+
34-
| RMSE_mult | root mean squared multiplicative error |
35-
+------------+--------------------------------------------------------------+
36-
| RV_add | reduction of variance (Brier Score, Nash-Sutcliffe Efficiency|
37-
+------------+--------------------------------------------------------------+
38-
| RV_mult | reduction of variance in multiplicative space |
39-
+------------+--------------------------------------------------------------+
19+
+------------+--------------------------------------------------------------+
20+
| Name | Description |
21+
+============+==============================================================+
22+
| beta | linear regression slope (conditional bias) |
23+
+------------+--------------------------------------------------------------+
24+
| corr_p | pearson's correleation coefficien (linear correlation) |
25+
+------------+--------------------------------------------------------------+
26+
| corr_s | spearman's correlation coefficient (rank correlation) |
27+
+------------+--------------------------------------------------------------+
28+
| ME_add | mean error or bias of additive residuals |
29+
+------------+--------------------------------------------------------------+
30+
| ME_mult | mean error or bias of multiplicative residuals |
31+
+------------+--------------------------------------------------------------+
32+
| RMSE_add | root mean squared additive error |
33+
+------------+--------------------------------------------------------------+
34+
| RMSE_mult | root mean squared multiplicative error |
35+
+------------+--------------------------------------------------------------+
36+
| RV_add | reduction of variance (Brier Score, Nash-Sutcliffe Efficiency|
37+
+------------+--------------------------------------------------------------+
38+
| RV_mult | reduction of variance in multiplicative space |
39+
+------------+--------------------------------------------------------------+
4040
4141
offset : float
4242
an offset that is added to both prediction and observation to avoid 0 division

0 commit comments

Comments
 (0)