Skip to content

Document the precision-at-K denominator for held-out items #760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
justavibedev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the precision-at-K denominator for held-out items #760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion implicit/evaluation.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,13 @@ def precision_at_k(model, train_user_items, test_user_items, int K=10,
show_progress=True, int num_threads=1):
""" Calculates P@K for a given trained model

The numerator counts hits in the top K recommendations across all users
with held-out items. Each of these users contributes the smaller of K
and their number of distinct held-out items to the denominator.

For example, at K=3, if two users have one and three held-out items
respectively, one hit for each user gives a score of 2 / (1 + 3) = 0.5.

Parameters
----------
model : RecommenderBase
Expand Down Expand Up @@ -390,7 +397,8 @@ def ranking_metrics_at_k(model, train_user_items, test_user_items, int K=10,
Returns
-------
dict[str, float]
the calculated metrics@k
The calculated metrics at K. The ``"precision"`` entry uses the
denominator described in :func:`precision_at_k`.
"""
if not isinstance(train_user_items, csr_matrix):
train_user_items = train_user_items.tocsr()
Expand Down