elliot.evaluation.metrics.accuracy.DSC package

Submodules

elliot.evaluation.metrics.accuracy.DSC.dsc module

This is the implementation of the Sørensen–Dice coefficient metric. It proceeds from a user-wise computation, and average the values over the users.

class elliot.evaluation.metrics.accuracy.DSC.dsc.DSC(recommendations, config, params, eval_objects, additional_data)[source]

Bases: elliot.evaluation.metrics.base_metric.BaseMetric

Sørensen–Dice coefficient

This class represents the implementation of the Sørensen–Dice coefficient recommendation metric. Passing ‘DSC’ to the metrics list will enable the computation of the metric.

For further details, please refer to the page

\[\mathrm {DSC@K} = \frac{1+\beta^{2}}{\frac{1}{\text { metric_0@k }}+\frac{\beta^{2}}{\text { metric_1@k }}}\]
Parameters

  • beta – the beta coefficient (default: 1)

  • metric_0 – First considered metric (default: Precision)

  • metric_1 – Second considered metric (default: Recall)

To compute the metric, add it to the config file adopting the following pattern:

complex_metrics:
- metric: DSC
  beta: 1
  metric_0: Precision
  metric_1: Recall
eval_user_metric()[source]

Evaluation function :return: the overall averaged value of Sørensen–Dice coefficient per user

static name()[source]

Metric Name Getter :return: returns the public name of the metric

Module contents