Single Dataset Performance

.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "tabular/auto_checks/model_evaluation/plot_single_dataset_performance.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note :ref:`Go to the end ` to download the full example code .. rst-class:: sphx-glr-example-title .. _sphx_glr_tabular_auto_checks_model_evaluation_plot_single_dataset_performance.py: .. _tabular__single_dataset_performance: Single Dataset Performance ***************************** This notebook provides an overview for using and understanding the single dataset performance check. **Structure:** * `What is the purpose of the check? <#what-is-the-purpose-of-the-check>`__ * `Generate data & model <#generate-data-model>`__ * `Run the check <#run-the-check>`__ * `Define a condition <#define-a-condition>`__ * `Using a custom scorer <#using-a-custom-scorer>`__ What is the purpose of the check? ================================== This check is designed for evaluating a model's performance on a labeled dataset based on a scorer or multiple scorers. Scorers are a convention of sklearn to evaluate a model, it is a function which accepts (model, X, y_true) and returns a float result which is the score. A sklearn convention is that higher scores are better than lower scores. For additional details `see scorers documentation `_. The default scorers that are used are F1, Precision, and Recall for Classification and Negative Root Mean Square Error, Negative Mean Absolute Error, and R2 for Regression. .. GENERATED FROM PYTHON SOURCE LINES 31-33 Generate data & model ====================== .. GENERATED FROM PYTHON SOURCE LINES 33-39 .. code-block:: default from deepchecks.tabular.datasets.classification.iris import load_data, load_fitted_model _, test_dataset = load_data() model = load_fitted_model() .. GENERATED FROM PYTHON SOURCE LINES 40-45 Run the check ============== You can select which scorers to use by passing either a list or a dict of scorers to the check, see :ref:`metrics_user_guide` for additional details. .. GENERATED FROM PYTHON SOURCE LINES 45-52 .. code-block:: default from deepchecks.tabular.checks import SingleDatasetPerformance check = SingleDatasetPerformance(scorers=['recall_per_class', 'precision_per_class', 'f1_macro', 'f1_micro']) result = check.run(test_dataset, model) result.show() .. raw:: html

.. GENERATED FROM PYTHON SOURCE LINES 53-59 Define a condition =================== We can define on our check a condition to validate that the different metric scores are above a certain threshold. Using the ``class_mode`` argument we can define select a sub set of the classes to use for the condition. Let's add a condition to the check and see what happens when it fails: .. GENERATED FROM PYTHON SOURCE LINES 59-64 .. code-block:: default check.add_condition_greater_than(threshold=0.85, class_mode='all') result = check.run(test_dataset, model) result.show(show_additional_outputs=False) .. raw:: html

Single Dataset Performance

.. GENERATED FROM PYTHON SOURCE LINES 65-66 We detected that the Recall score is below specified threshold in at least one of the classes. .. GENERATED FROM PYTHON SOURCE LINES 68-72 Using a custom scorer ========================= In addition to the built-in scorers, we can define our own scorer based on sklearn api and run it using the check alongside other scorers: .. GENERATED FROM PYTHON SOURCE LINES 72-80 .. code-block:: default from sklearn.metrics import fbeta_score, make_scorer fbeta_scorer = make_scorer(fbeta_score, labels=[0, 1, 2], average=None, beta=0.2) check = SingleDatasetPerformance(scorers={'my scorer': fbeta_scorer, 'recall': 'recall_per_class'}) result = check.run(test_dataset, model) result.show() .. raw:: html

Single Dataset Performance

.. rst-class:: sphx-glr-timing **Total running time of the script:** (0 minutes 2.748 seconds) .. _sphx_glr_download_tabular_auto_checks_model_evaluation_plot_single_dataset_performance.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: plot_single_dataset_performance.py ` .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: plot_single_dataset_performance.ipynb ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_