diff --git a/README.md b/README.md index 99b0437..8836bfa 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ ![Docs](https://readthedocs.org/projects/calzone-docs/badge/) [![PyPI version](https://badge.fury.io/py/calzone-tool.svg)](https://badge.fury.io/py/calzone-tool) -`calzone` is a comprehensive Python package for calculating and visualizing various metrics for assessing the calibration of models with probabilistic output. - -To accurately assess the calibration of machine learning models, it is essential to have a comprehensive and representative dataset with sufficient coverage of the prediction space. The calibration metrics is not meaningful if the dataset is not representative of true intended population. +`calzone` is a comprehensive Python package for calculating and visualizing metrics for assessing the calibration of models with probabilistic output. ## Features @@ -15,6 +13,8 @@ To accurately assess the calibration of machine learning models, it is essential - Prevelance adjustment to account for prevalance change between enriched data and population data. - Multiclass extension by 1-vs-rest or top-class only +_To accurately assess the calibration of machine learning models, it is essential to have a comprehensive and representative dataset with sufficient coverage of the prediction space. The calibration metrics are not meaningful if the dataset is not representative of true intended population._ + ## Installation You can install calzone using pip: