Skip to content

Commit 3170dcd

Browse files
committed
docs: update ranking metric docs
(cherry picked from commit baf8613)
1 parent 1b2b956 commit 3170dcd

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

docs/guide/evaluation/rankings.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,18 @@ list and a test rating list, both as :py:class:`item lists
1515
<lenskit.data.ItemList>`; most metrics require the recommendation item list to
1616
be :py:attr:`~lenskit.data.ItemList.ordered`.
1717

18-
All LensKit ranking metrics take `k` as a constructor argument to control the
18+
All LensKit ranking metrics take ``n`` as a constructor argument to control the
1919
list of the length that is considered; this allows multiple measurements (e.g.
2020
HR@5 and HR@10) to be computed from a single set of rankings.
2121

22+
.. versionchanged:: 2026.1
23+
24+
The argument for the list length has changed from ``k`` to ``n``, for
25+
consistency across LensKit. ``k`` is kept as a deprecated alias until
26+
2027.1.
27+
2228
.. versionchanged:: 2025.1
29+
2330
The top-N accuracy metric interface has changed to use item lists, and to
2431
be simpler to implement.
2532

0 commit comments

Comments
 (0)