.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "vision/auto_checks/model_evaluation/plot_mean_average_recall_report.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_vision_auto_checks_model_evaluation_plot_mean_average_recall_report.py: .. _vision__mean_average_recall_report: Mean Average Recall Report ************************** This notebooks provides an overview for using and understanding the mean average recall report check. **Structure:** * `What is the purpose of the check? <#what-is-the-purpose-of-the-check>`__ * `Generate Dataset <#generate-dataset>`__ * `Run the check <#run-the-check>`__ * `Define a condition <#define-a-condition>`__ What is the purpose of the check? ================================= The Mean Average Recall Report evaluates the `mAR metric `__ on the given model and data, and returns the mAR values per bounding box size category (small, medium, large). This check only works on the Object Detection task. .. GENERATED FROM PYTHON SOURCE LINES 26-34 Imports ------- .. note:: In this example, we use the pytorch version of the coco dataset and model. In order to run this example using tensorflow, please change the import statements to:: from deepchecks.vision.datasets.detection import coco_tensorflow as coco .. GENERATED FROM PYTHON SOURCE LINES 34-38 .. code-block:: default from deepchecks.vision.checks import MeanAverageRecallReport from deepchecks.vision.datasets.detection import coco_torch as coco .. GENERATED FROM PYTHON SOURCE LINES 39-46 Generate Dataset ---------------- We generate a sample dataset of 128 images from the `COCO dataset `__, and using the `YOLOv5 model `__. For the label formatter - our dataset returns exactly the accepted format, so our formatting function is the simple `lambda x: x` function. .. GENERATED FROM PYTHON SOURCE LINES 46-49 .. code-block:: default test_ds = coco.load_dataset(train=False, object_type='VisionData') .. GENERATED FROM PYTHON SOURCE LINES 50-52 Run the check ------------- .. GENERATED FROM PYTHON SOURCE LINES 52-57 .. code-block:: default check = MeanAverageRecallReport() result = check.run(test_ds) result .. rst-class:: sphx-glr-script-out .. code-block:: none Processing Batches: | | 0/1 [Time: 00:00] Processing Batches: |█████| 1/1 [Time: 00:00] Processing Batches: |█████| 1/1 [Time: 00:00] Computing Check: | | 0/1 [Time: 00:00] Computing Check: |█████| 1/1 [Time: 00:00] Computing Check: |█████| 1/1 [Time: 00:00] .. raw:: html
Mean Average Recall Report


.. GENERATED FROM PYTHON SOURCE LINES 58-59 To display the results in an IDE like PyCharm, you can use the following code: .. GENERATED FROM PYTHON SOURCE LINES 59-61 .. code-block:: default # result.show_in_window() .. GENERATED FROM PYTHON SOURCE LINES 62-63 The result will be displayed in a new window. .. GENERATED FROM PYTHON SOURCE LINES 65-68 Observe the check’s output -------------------------- The result value is a dataframe that has the average recall score per each area range and IoU. .. GENERATED FROM PYTHON SOURCE LINES 68-71 .. code-block:: default result.value .. raw:: html
AR@1 (%) AR@10 (%) AR@100 (%)
Area size
All 0.330552 0.423444 0.429179
Small (area < 32^2) 0.104955 0.220594 0.220594
Medium (32^2 < area < 96^2) 0.325099 0.417392 0.423844
Large (area < 96^2) 0.481611 0.544408 0.549963


.. GENERATED FROM PYTHON SOURCE LINES 72-76 Define a condition ================== We can define a condition that checks whether our model's average recall score is not less than a given threshold .. GENERATED FROM PYTHON SOURCE LINES 76-80 .. code-block:: default check = MeanAverageRecallReport().add_condition_test_average_recall_greater_than(0.4) result = check.run(test_ds) result.show(show_additional_outputs=False) .. rst-class:: sphx-glr-script-out .. code-block:: none Processing Batches: | | 0/1 [Time: 00:00] Processing Batches: |█████| 1/1 [Time: 00:00] Processing Batches: |█████| 1/1 [Time: 00:00] Computing Check: | | 0/1 [Time: 00:00] Computing Check: |█████| 1/1 [Time: 00:00] Computing Check: |█████| 1/1 [Time: 00:00] .. raw:: html
Mean Average Recall Report


.. rst-class:: sphx-glr-timing **Total running time of the script:** (0 minutes 3.665 seconds) .. _sphx_glr_download_vision_auto_checks_model_evaluation_plot_mean_average_recall_report.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_mean_average_recall_report.py ` .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: plot_mean_average_recall_report.ipynb ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_