elliot.evaluation.metrics package

Subpackages

• elliot.evaluation.metrics.accuracy package
  • Subpackages
    • elliot.evaluation.metrics.accuracy.AUC package
      • Submodules
      • elliot.evaluation.metrics.accuracy.AUC.auc module
      • elliot.evaluation.metrics.accuracy.AUC.gauc module
      • elliot.evaluation.metrics.accuracy.AUC.lauc module
      • Module contents
    • elliot.evaluation.metrics.accuracy.DSC package
      • Submodules
      • elliot.evaluation.metrics.accuracy.DSC.dsc module
      • Module contents
    • elliot.evaluation.metrics.accuracy.f1 package
      • Submodules
      • elliot.evaluation.metrics.accuracy.f1.extended_f1 module
      • elliot.evaluation.metrics.accuracy.f1.f1 module
      • Module contents
    • elliot.evaluation.metrics.accuracy.hit_rate package
      • Submodules
      • elliot.evaluation.metrics.accuracy.hit_rate.hit_rate module
      • Module contents
    • elliot.evaluation.metrics.accuracy.map package
      • Submodules
      • elliot.evaluation.metrics.accuracy.map.map module
      • Module contents
    • elliot.evaluation.metrics.accuracy.mar package
      • Submodules
      • elliot.evaluation.metrics.accuracy.mar.mar module
      • Module contents
    • elliot.evaluation.metrics.accuracy.mrr package
      • Submodules
      • elliot.evaluation.metrics.accuracy.mrr.mrr module
      • Module contents
    • elliot.evaluation.metrics.accuracy.ndcg package
      • Submodules
      • elliot.evaluation.metrics.accuracy.ndcg.ndcg module
      • Module contents
      • elliot.evaluation.metrics.accuracy.ndcg.ndcg_rendle2020 module
      • Module contents
    • elliot.evaluation.metrics.accuracy.precision package
      • Submodules
      • elliot.evaluation.metrics.accuracy.precision.precision module
      • Module contents
    • elliot.evaluation.metrics.accuracy.recall package
      • Submodules
      • elliot.evaluation.metrics.accuracy.recall.recall module
      • Module contents
  • Module contents
• elliot.evaluation.metrics.bias package
  • Subpackages
    • elliot.evaluation.metrics.bias.aclt package
      • Submodules
      • elliot.evaluation.metrics.bias.aclt.aclt module
      • Module contents
    • elliot.evaluation.metrics.bias.aplt package
      • Submodules
      • elliot.evaluation.metrics.bias.aplt.aplt module
      • Module contents
    • elliot.evaluation.metrics.bias.arp package
      • Submodules
      • elliot.evaluation.metrics.bias.arp.arp module
      • Module contents
    • elliot.evaluation.metrics.bias.pop_reo package
      • Submodules
      • elliot.evaluation.metrics.bias.pop_reo.extended_pop_reo module
      • elliot.evaluation.metrics.bias.pop_reo.pop_reo module
      • Module contents
    • elliot.evaluation.metrics.bias.pop_rsp package
      • Submodules
      • elliot.evaluation.metrics.bias.pop_rsp.extended_pop_rsp module
      • elliot.evaluation.metrics.bias.pop_rsp.pop_rsp module
      • Module contents
  • Module contents
• elliot.evaluation.metrics.coverage package
  • Subpackages
    • elliot.evaluation.metrics.coverage.item_coverage package
      • Submodules
      • elliot.evaluation.metrics.coverage.item_coverage.item_coverage module
      • Module contents
    • elliot.evaluation.metrics.coverage.num_retrieved package
      • Submodules
      • elliot.evaluation.metrics.coverage.num_retrieved.num_retrieved module
      • Module contents
    • elliot.evaluation.metrics.coverage.user_coverage package
      • Submodules
      • elliot.evaluation.metrics.coverage.user_coverage.user_coverage module
      • elliot.evaluation.metrics.coverage.user_coverage.user_coverage_at_n module
      • Module contents
  • Module contents
• elliot.evaluation.metrics.diversity package
  • Subpackages
    • elliot.evaluation.metrics.diversity.SRecall package
      • Submodules
      • elliot.evaluation.metrics.diversity.SRecall.srecall module
      • Module contents
    • elliot.evaluation.metrics.diversity.gini_index package
      • Submodules
      • elliot.evaluation.metrics.diversity.gini_index.gini_index module
      • Module contents
    • elliot.evaluation.metrics.diversity.shannon_entropy package
      • Submodules
      • elliot.evaluation.metrics.diversity.shannon_entropy.shannon_entropy module
      • Module contents
  • Module contents
• elliot.evaluation.metrics.fairness package
  • Subpackages
    • elliot.evaluation.metrics.fairness.BiasDisparity package
      • Submodules
      • elliot.evaluation.metrics.fairness.BiasDisparity.BiasDisparityBD module
      • elliot.evaluation.metrics.fairness.BiasDisparity.BiasDisparityBR module
      • elliot.evaluation.metrics.fairness.BiasDisparity.BiasDisparityBS module
      • Module contents
    • elliot.evaluation.metrics.fairness.MAD package
      • Submodules
      • elliot.evaluation.metrics.fairness.MAD.ItemMADranking module
      • elliot.evaluation.metrics.fairness.MAD.ItemMADrating module
      • elliot.evaluation.metrics.fairness.MAD.UserMADranking module
      • elliot.evaluation.metrics.fairness.MAD.UserMADrating module
      • Module contents
    • elliot.evaluation.metrics.fairness.reo package
      • Submodules
      • elliot.evaluation.metrics.fairness.reo.reo module
      • Module contents
    • elliot.evaluation.metrics.fairness.rsp package
      • Submodules
      • elliot.evaluation.metrics.fairness.rsp.rsp module
      • Module contents
  • Module contents
• elliot.evaluation.metrics.novelty package
  • Subpackages
    • elliot.evaluation.metrics.novelty.EFD package
      • Submodules
      • elliot.evaluation.metrics.novelty.EFD.efd module
      • elliot.evaluation.metrics.novelty.EFD.extended_efd module
      • Module contents
    • elliot.evaluation.metrics.novelty.EPC package
      • Submodules
      • elliot.evaluation.metrics.novelty.EPC.epc module
      • elliot.evaluation.metrics.novelty.EPC.extended_epc module
      • Module contents
  • Module contents
• elliot.evaluation.metrics.rating package
  • Subpackages
    • elliot.evaluation.metrics.rating.mae package
      • Submodules
      • elliot.evaluation.metrics.rating.mae.mae module
      • Module contents
    • elliot.evaluation.metrics.rating.mse package
      • Submodules
      • elliot.evaluation.metrics.rating.mse.mse module
      • Module contents
    • elliot.evaluation.metrics.rating.rmse package
      • Submodules
      • elliot.evaluation.metrics.rating.rmse.rmse module
      • Module contents
  • Module contents

Submodules

elliot.evaluation.metrics.base_metric module

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

class elliot.evaluation.metrics.base_metric.BaseMetric(recommendations, config, params, evaluation_objects, additional_data=None)

Bases: abc.ABC

This class represents the implementation of the Precision recommendation metric. Passing ‘Precision’ to the metrics list will enable the computation of the metric.

eval()

get()

abstract name()

static needs_full_recommendations()

elliot.evaluation.metrics.metrics_utils module

class elliot.evaluation.metrics.metrics_utils.ProxyMetric(name='ProxyMetric', val=0, needs_full_recommendations=False)

Bases: elliot.evaluation.metrics.base_metric.BaseMetric

eval()

name()

needs_full_recommendations()

class elliot.evaluation.metrics.metrics_utils.ProxyStatisticalMetric(name='ProxyMetric', val=0, user_val=0, needs_full_recommendations=False)

Bases: elliot.evaluation.metrics.base_metric.BaseMetric

eval()

eval_user_metric()

name()

needs_full_recommendations()

elliot.evaluation.metrics.statistical_array_metric module

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

class elliot.evaluation.metrics.statistical_array_metric.StatisticalMetric

Bases: object

This class represents the implementation of the Precision recommendation metric. Passing ‘Precision’ to the metrics list will enable the computation of the metric.

abstract eval_user_metric()

Module contents

This is the metrics’ module.

This module contains and expose the recommendation metrics. Each metric is encapsulated in a specific package.

See the implementation of Precision metric for creating new per-user metrics. See the implementation of Item Coverage for creating new cross-user metrics.

elliot.evaluation.metrics.parse_metric(metric)

elliot.evaluation.metrics.parse_metrics(metrics)