added isotonic regression to docs

nci · Nov 16, 2023 · 9652e81 · 9652e81
1 parent 5393a4e
commit 9652e81
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 One-line intro: xarray based verification (accuracy) scoring that can scale with Dask if needed. Pandas supported where possible.
 Why use it: trusted implementations, novel metrics, performance, one-stop-shop.
 
-Currently Included Metrics:
+Currently Included Metrics and Tools:
 
-| continuous                      | probability | categorical      | statistical tests |
-| ----------                      | ----------- | -----------      | ----------------- |
-| MAE, MSE, RMSE, Flip Flop Index | CRPS, ROC   | FIRM, POD, POFD  |  Diebold Mariano (with the Harvey et al. 1997 and the Hering and Genton 2011 modifications) |
+| continuous                                           | probability | categorical      | statistical tests |
+| ----------                                           | ----------- | -----------      | ----------------- |
+| MAE, MSE, RMSE, Flip Flop Index, isotonic regression | CRPS, ROC   | FIRM, POD, POFD  |  Diebold Mariano (with the Harvey et al. 1997 and the Hering and Genton 2011 modifications) |
 
 
 **Notice -- This repository is currently undergoing initial construction and maintenance. It is not yet recommended for use. This notice will be removed after the first feature release. In the meantime, please feel free to look around, and don't hesitate to get in touch with any questions (see the contributing guide for how).**

diff --git a/docs/api.md b/docs/api.md
@@ -17,6 +17,7 @@
 .. autofunction:: scores.continuous.murphy_score
 .. autofunction:: scores.continuous.murphy.thetas
 .. autofunction:: scores.continuous.flip_flop_index
+.. autofunction:: scores.continuous.isotonic_fit
 ```
 
 ## scores.probability

diff --git a/docs/summary_table_of_scores.md b/docs/summary_table_of_scores.md
@@ -1,3 +1,3 @@
-| continuous                   | probability                        | categorical                      | statistical tests      |
-| ----------                   | -----------                        | -----------                      | -----------            |
-| MAE, MSE, RMSE, Murphy score | CRPS_CDF, Murphy score, ROC        | FIRM, POD, POFD, Flip Flop Index | Diebold Mariano (with the Harvey et al. 1997 and the Hering and Genton 2011 modifications)|
+| continuous                                 | probability                        | categorical                      | statistical tests      |
+| ----------                                 | -----------                        | -----------                      | -----------            |
+| MAE, MSE, RMSE, Murphy score, isotonic_fit | CRPS_CDF, Murphy score, ROC        | FIRM, POD, POFD, Flip Flop Index | Diebold Mariano (with the Harvey et al. 1997 and the Hering and Genton 2011 modifications)|