From 9652e81af2d6e133bd77dc7da8d3f5e405b08f45 Mon Sep 17 00:00:00 2001 From: Nicholas Loveday Date: Thu, 16 Nov 2023 16:00:08 +1100 Subject: [PATCH] added isotonic regression to docs --- README.md | 8 ++++---- docs/api.md | 1 + docs/summary_table_of_scores.md | 6 +++--- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eedf00b44..85fe01710 100644 --- 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 index 32ccdaf44..ecc24f4d3 100644 --- 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 index 605c8b21c..3c873941c 100644 --- 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)|