vision_unlearning.evaluator.class_unlearning
============================================

.. py:module:: vision_unlearning.evaluator.class_unlearning


Functions
---------

.. autoapisummary::

   vision_unlearning.evaluator.class_unlearning.average_metrics
   vision_unlearning.evaluator.class_unlearning._convert_mean_to_std
   vision_unlearning.evaluator.class_unlearning.format_metrics_as_markdown


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

.. py:function:: average_metrics(name_to_value_all: List[Dict[str, float | int | bool]]) -> Dict[str, float]

.. py:function:: _convert_mean_to_std(name: str) -> str

.. py:function:: format_metrics_as_markdown(name_to_value: Dict[str, Union[float, int, bool]], name_to_value_all: Optional[Dict[str, Dict[str, Union[float, int, bool]]]] = None) -> str

   Formats metrics as a markdown table. Can display either just overall metrics
   or include per-class metrics as additional columns.

   :param name_to_value: Dictionary of overall/average metrics
   :param name_to_value_all: Optional dictionary of per-class metrics

   :returns: Markdown formatted table
   :rtype: str