From cb6e6b3c73fa132c50b6d76e8b340cfe9941d9da Mon Sep 17 00:00:00 2001 From: Niels Nuyttens Date: Thu, 25 Apr 2024 13:37:59 +0100 Subject: [PATCH] Update data requirements docs --- docs/tutorials/data_requirements.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/data_requirements.rst b/docs/tutorials/data_requirements.rst index 13e1155af..6467dc03c 100644 --- a/docs/tutorials/data_requirements.rst +++ b/docs/tutorials/data_requirements.rst @@ -170,7 +170,7 @@ The :term:`predicted label`, retrieved by interpreting (thresh In the sample data this is the **y_pred** column. Required for running :ref:`performance estimation` or :ref:`performance calculation` on binary classification, multiclass, and regression models. - +On binary classification models, it is not required for calculating the **AUROC** and **average precision** metrics. NannyML Functionality Requirements ---------------------------------- @@ -190,7 +190,8 @@ You can see those requirements in the table below: | y_pred_proba | Required (reference and analysis) | | | | | | Required (reference and analysis) | +--------------+-------------------------------------+-------------------------------------+-------------------------------------+-----------------------------------+-----------------------------------+-----------------------------------+-----------------------------------+ | y_pred | | Required (reference and analysis) | Required (reference and analysis) | | Required (reference and analysis) | | | | Required (reference and analysis) | -| | | Not needed for ROC_AUC metric | | | Not needed for ROC_AUC metric | | | | | +| | | Not needed for ROC_AUC or | | | Not needed for ROC_AUC or | | | | | +| | | average precision metrics | | | average precision metrics | | | | | +--------------+-------------------------------------+-------------------------------------+-------------------------------------+-----------------------------------+-----------------------------------+-----------------------------------+-----------------------------------+ | y_true | Required (reference only) | Required (reference only) | Required (reference and analysis) | | | Required (reference and analysis) | | +--------------+-------------------------------------+-------------------------------------+-------------------------------------+-----------------------------------+-----------------------------------+-----------------------------------+-----------------------------------+