add comment regarding sorting to FFScore

mrjleo · Dec 15, 2024 · ee8b74d · ee8b74d
1 parent d8aad79
commit ee8b74d
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/fast_forward/util/pyterrier.py b/src/fast_forward/util/pyterrier.py
@@ -35,6 +35,7 @@ def transform(self, inp: "pd.DataFrame") -> "pd.DataFrame":
             Ranking(
                 inp.rename(columns={"qid": "q_id", "docno": "id"}),
                 copy=False,
+                # since this ranking is only used for scoring, sorting is not necessary
                 is_sorted=True,
             )
         )._df.rename(columns={"q_id": "qid", "id": "docno"})