KerasRS / API 文档 / 指标 / nDCG 指标

nDCG 指标

[源代码]

NDCG

keras_rs.metrics.NDCG(
    k: int | None = None,
    gain_fn: Callable[[Any], Any] = default_gain_fn,
    rank_discount_fn: Callable[[Any], Any] = default_rank_discount_fn,
    **kwargs: Any
)

计算归一化折损累积增益 (nDCG)。

此指标评估排名质量。它通过每列表的理想折损累积增益 (IDCG) 来归一化折损累积增益 (DCG)。该指标处理 y_true 中的真实相关性标签(分级相关性得分(非负数,值越高表示相关性越大))与 y_pred 中的预测得分。y_pred 中的得分用于通过降序排序来确定项目的排名顺序。返回一个归一化得分(介于 0 和 1 之间)。得分为 1 表示根据真实相关性(在 top-k 内)的完美排名,而 0 通常表示没有相关项目的排名。较高的得分表示相对于最佳可能排名的更好排名质量。

对于 y_pred 中每个预测得分列表 sy_true 中相应的真实标签列表 y,每查询 nDCG 得分计算如下:

nDCG@k = DCG@k / IDCG@k

其中 DCG@k 是根据预测排名 (y_pred) 计算的

DCG@k(y') = sum_{i=1}^{k} (gain_fn(y'_i) / rank_discount_fn(i))

而 IDCG@k 是理想 DCG,使用相同的公式计算,但基于按其*真实相关性*(y_true)完美排序的项目

IDCG@k(y'') = sum_{i=1}^{k} (gain_fn(y''_i) / rank_discount_fn(i))

其中

  • y'_i:在 y_pred 引起的排名中,位于排名 i 的项目的真实相关性。
  • y''_i:在*理想*排名(按 y_true 降序排序)中,位于排名 i 的项目的真实相关性。
  • gain_fn 是用户提供的将相关性映射到增益的函数。默认函数 (default_gain_fn) 通常等效于 lambda y: 2**y - 1
  • rank_discount_fn 是用户提供的将排名 i(1-based)映射到折损值的函数。默认函数 (default_rank_discount_fn) 通常等效于 lambda rank: 1 / log2(rank + 1)
  • 如果 IDCG@k 为 0(例如,没有相关项目),则 nDCG@k 定义为 0。
  • 最终结果通常会聚合这些每列表 nDCG 分数,可能涉及按列表特定权重进行归一化,以产生加权平均值。

报告的最终 nDCG 得分通常是数据集中所有查询/列表的这些每查询得分的加权平均值。

注意:sample_weight 在排名指标中处理方式不同。对于批量输入,sample_weight 可以是标量、1D、2D。标量情况和 1D 情况(列表级权重)很简单。2D 情况(项目级权重)不同,因为样本权重会被聚合以获得 1D 权重。有关更多详细信息,请参阅 keras_rs.src.metrics.ranking_metrics_utils.get_list_weights

参数

  • gain_fn:可调用对象。将相关性分数 (y_true) 映射到增益值。默认实现 2**y - 1
  • rank_discount_fn:函数。将排名位置映射到折损值。默认值 (default_rank_discount_fn) 实现 1 / log2(rank + 1)
  • k: int。要考虑的排名前 k 个项目的数量(“top-k”中的“k”)。必须是正整数。
  • shuffle_ties: bool。是否在排序前随机打乱分数。这样做是为了打破平局。默认为 True
  • seed: int。用于打乱的随机种子。
  • name: 损失实例的可选名称。
  • dtype:指标计算的数据类型。默认为 None,表示使用 keras.backend.floatx()keras.backend.floatx() 除非设置为其他值(通过 keras.backend.set_floatx()),否则为 "float32"。如果提供了 keras.DTypePolicy,则将使用 compute_dtype

示例

>>> batch_size = 2
>>> list_size = 5
>>> labels = np.random.randint(0, 3, size=(batch_size, list_size))
>>> scores = np.random.random(size=(batch_size, list_size))
>>> metric = keras_rs.metrics.NDCG()(
...     y_true=labels, y_pred=scores
... )

屏蔽某些元素(可用于不均匀输入)

>>> batch_size = 2
>>> list_size = 5
>>> labels = np.random.randint(0, 3, size=(batch_size, list_size))
>>> scores = np.random.random(size=(batch_size, list_size))
>>> mask = np.random.randint(0, 2, size=(batch_size, list_size), dtype=bool)
>>> metric = keras_rs.metrics.NDCG()(
...     y_true={"labels": labels, "mask": mask}, y_pred=scores
... )