elliot.evaluation.metrics.diversity.SRecall package

Submodules

elliot.evaluation.metrics.diversity.SRecall.srecall module

This is the implementation of the SRecall metric. It proceeds from a user-wise computation, and average the values over the users.

class elliot.evaluation.metrics.diversity.SRecall.srecall.SRecall(recommendations, config, params, eval_objects, additional_data)

Bases: elliot.evaluation.metrics.base_metric.BaseMetric

Subtopic Recall

This class represents the implementation of the Subtopic Recall (S-Recall) recommendation metric.

For further details, please refer to the paper

\[\mathrm {SRecall}=\frac{\left|\cup_{i=1}^{K} {subtopics}\left(d_{i}\right)\right|}{n_{A}}\]

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

simple_metrics: [SRecall]

eval_user_metric()

Evaluation function :return: the overall averaged value of SRecall

static name()

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

Module contents