flurs.metrics

flurs.metrics.auc(truth, recommend)[source]

Area under the ROC curve (AUC).

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

Returns

AUC.

Return type

float

flurs.metrics.average_precision(truth, recommend)[source]

Average Precision (AP).

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

Returns

Average Precision.

Return type

float

flurs.metrics.mpr(truth, recommend)[source]

Mean Percentile Rank (MPR).

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

Returns

Mean Percentile Rank.

Return type

float

flurs.metrics.ndcg(truth, recommend, k=None)[source]

Normalized Discounted Cumulative Grain (NDCG).

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

  • k (int or None, default=None) – Top-k items in recommend are considered to be recommended. Defaults to len(recommend).

Returns

NDCG@k.

Return type

float

flurs.metrics.precision(truth, recommend, k=None)[source]

Precision@k.

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

  • k (int or None, default=None) – Top-k items in recommend are considered to be recommended. Defaults to len(recommend).

Returns

Precision@k.

Return type

float

flurs.metrics.recall(truth, recommend, k=None)[source]

Recall@k.

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

  • k (int or None, default=None) – Top-k items in recommend are considered to be recommended. Defaults to len(recommend).

Returns

Recall@k.

Return type

float

flurs.metrics.reciprocal_rank(truth, recommend)[source]

Reciprocal Rank (RR).

Parameters

  • truth (numpy 1d array) – Set of truth samples.

  • recommend (numpy 1d array) – Ordered listed of recommended samples.

Returns

Reciprocal Rank.

Return type

float