task_metric

TaskMetric

Bases: Metric

Wrapper-class for task-specific metrics.

Source code in lightning_boost/modules/metrics/task_metric.py

class TaskMetric(Metric):
    """Wrapper-class for task-specific metrics."""

    def __init__(self, instance: Metric, task: str = 'base-task') -> None:
        """
        Initializes task-specific metric.

        Args:
            instance (Metric): Metric.
            task (str, optional): Task. Defaults to 'base-task'.
        """

        super().__init__()
        self.instance = instance
        self.task = task

    def update(self, *args, **kwargs) -> None:
        """
        Performs metric update.
        """

        self.instance.update(*args, **kwargs)

    def compute(self) -> Any:
        """
        Evaluates metric.

        Returns:
            Any: Metric value.
        """

        return self.instance.compute()

__init__(instance, task='base-task')

Initializes task-specific metric.

Parameters:

Name	Type	Description	Default
instance	Metric	Metric.	required
task	str	Task. Defaults to 'base-task'.	'base-task'

Source code in lightning_boost/modules/metrics/task_metric.py

def __init__(self, instance: Metric, task: str = 'base-task') -> None:
    """
    Initializes task-specific metric.

    Args:
        instance (Metric): Metric.
        task (str, optional): Task. Defaults to 'base-task'.
    """

    super().__init__()
    self.instance = instance
    self.task = task

compute()

Evaluates metric.

Returns:

Name	Type	Description
Any	Any	Metric value.

Source code in lightning_boost/modules/metrics/task_metric.py

def compute(self) -> Any:
    """
    Evaluates metric.

    Returns:
        Any: Metric value.
    """

    return self.instance.compute()

update(*args, **kwargs)

Performs metric update.

Source code in lightning_boost/modules/metrics/task_metric.py

def update(self, *args, **kwargs) -> None:
    """
    Performs metric update.
    """

    self.instance.update(*args, **kwargs)