yolo.model.metrics
==================

.. py:module:: yolo.model.metrics


Attributes
----------

.. autoapisummary::

   yolo.model.metrics.YOLO_METRICS_MAP


Classes
-------

.. autoapisummary::

   yolo.model.metrics.Metrics
   yolo.model.metrics.MetricParser


Module Contents
---------------

.. py:data:: YOLO_METRICS_MAP

.. py:class:: Metrics(task: str, results: ultralytics.engine.results, metrics_list: list)

   Class for computing metrics.


   .. py:attribute:: _TASKS_AVAILABLE


   .. py:attribute:: _METRICS_AVAILABLE


   .. py:attribute:: task


   .. py:attribute:: results


   .. py:attribute:: metrics_list


   .. py:attribute:: metric_dict


   .. py:method:: metrics_task(results: ultralytics.engine.results, task: str)
      :staticmethod:


      Return the task metrics to be computes.

      :param results: Results as defined by Ultralytics.
      :type results: r
      :param task: segment or detect or obb.
      :type task: str

      :returns: `results.seg` for segment or `results.box` for detect or obb.



   .. py:method:: compute_metrics()

      Compute all metrics contained in parameter.



   .. py:method:: _compute_metric(metric: str)

      Check if the metric is available and return the associated yolo metric.



.. py:class:: MetricParser(filepath: str)

   Class for parsing Ultralytics metrics in results.csv.


   .. py:attribute:: df


   .. py:method:: log_metrics()

      Log the metrics inside the csv file.