nucleus.evaluation_v2
=====================

.. py:module:: nucleus.evaluation_v2

.. autoapi-nested-parse::

   Evaluation V2 — metrics and examples for a model run.






.. autoapisummary::
   nucleus.evaluation_v2.AllowedLabelMatch
   nucleus.evaluation_v2.EvaluationV2
   nucleus.evaluation_v2.EvaluationV2Status


.. py:class:: AllowedLabelMatch


   Ground-truth and prediction label pair that counts as a match.




.. py:class:: EvaluationV2


   An Evaluation V2 run for a model run.



   .. py:method:: charts(iou_threshold = 0.5, filters = None, query = None)

      Return aggregate metrics for this evaluation.

      :param iou_threshold: IoU threshold for matching (default 0.5).
      :param filters: Optional filters (:class:`EvaluationV2FilterArgs` or dict).
      :param query: Optional query string to narrow results.

      :returns: Summary metrics (mAP, confusion matrix, PR curve, etc.).
      :rtype: :class:`EvaluationV2Charts`


   .. py:method:: delete()

      Delete this evaluation.


   .. py:method:: examples(match_type, limit = 50, offset = 0, sort_by = None, sort_order = None, filters = None, query = None)

      Return paginated true-positive, false-positive, or false-negative examples.

      :param match_type: ``"TP"``, ``"FP"``, or ``"FN"``.
      :param limit: Page size (default 50).
      :param offset: Row offset for pagination.
      :param sort_by: Optional field to sort by.
      :param sort_order: Optional sort direction (e.g. ``"asc"`` or ``"desc"``).
      :param filters: Optional filters (:class:`EvaluationV2FilterArgs` or dict).
      :param query: Optional query string to narrow results.

      :returns: Matching rows and total count.
      :rtype: :class:`EvaluationV2ExamplesPage`


   .. py:method:: refresh()

      Reload this evaluation from Nucleus.

      :returns: self, with updated fields.


   .. py:method:: wait_for_completion(timeout_sec = 600, poll_interval = 5)

      Wait until the evaluation finishes or is cancelled.

      :param timeout_sec: Maximum seconds to wait.
      :param poll_interval: Seconds between status checks.

      :returns: self, after a terminal status is reached.

      :raises RuntimeError: If the evaluation fails or times out.



.. py:class:: EvaluationV2Status




   Status of an Evaluation V2 run.

   Initialize self.  See help(type(self)) for accurate signature.