From 10249a47ebdfc7c025d7a6a22f4513ba5943ab50 Mon Sep 17 00:00:00 2001 From: Imad Saddik <79410781+ImadSaddik@users.noreply.github.com> Date: Sat, 13 Sep 2025 11:11:54 +0100 Subject: [PATCH 1/5] Fixed a typo in the save section in run.md --- docs/run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/run.md b/docs/run.md index 55f5527..f44b5d5 100644 --- a/docs/run.md +++ b/docs/run.md @@ -80,7 +80,7 @@ run = Run.from_parquet( ## Save Write `run` to `path` as JSON file, TREC run, LZ4 file, or Parquet file. -File type is automatically inferred form the filename extension: `.json` -> `json`, `.trec` -> `trec`, `.txt` -> `trec`, and `.lz4` -> `lz4`, `.parq` -> `parquet`, `.parquet` -> `parquet`. +File type is automatically inferred from the filename extension: `.json` -> `json`, `.trec` -> `trec`, `.txt` -> `trec`, and `.lz4` -> `lz4`, `.parq` -> `parquet`, `.parquet` -> `parquet`. Use the `kind` argument to override this behavior. ```python From c2c28a6c7dcbb130d630395582261a01b19cd062 Mon Sep 17 00:00:00 2001 From: Imad Saddik <79410781+ImadSaddik@users.noreply.github.com> Date: Sat, 13 Sep 2025 11:16:21 +0100 Subject: [PATCH 2/5] Fixed a typo in report.md --- docs/report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/report.md b/docs/report.md index bdee714..09403d4 100644 --- a/docs/report.md +++ b/docs/report.md @@ -1,7 +1,7 @@ # Report A `Report` instance is automatically generated as the results of a comparison. -A `Report` provides a convenient way of inspecting a comparison results and exporting those il LaTeX for your scientific publications. +A `Report` provides a convenient way of inspecting a comparison results and exporting those in LaTeX for your scientific publications. By changing the values of the parameters `rounding_digits` (int) and `show_percentages` (bool) you can control what is shown on printing and when generating LaTeX tables. ```python From ef4d4d8a28f09b8bbafea5657e8c09d91e50b8b2 Mon Sep 17 00:00:00 2001 From: Imad Saddik <79410781+ImadSaddik@users.noreply.github.com> Date: Sat, 13 Sep 2025 11:19:21 +0100 Subject: [PATCH 3/5] Fixed a typo in qrels.md --- docs/qrels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/qrels.md b/docs/qrels.md index 25e7562..80abd12 100644 --- a/docs/qrels.md +++ b/docs/qrels.md @@ -79,7 +79,7 @@ qrels = Qrels.from_parquet( ## Save Write `qrels` to `path` as JSON file or TREC qrels format. -File type is automatically inferred form the filename extension: `.json` -> `json`, `.trec` -> `trec`, `.txt` -> `trec`, `.parq` -> `parquet`, `.parquet` -> `parquet`. +File type is automatically inferred from the filename extension: `.json` -> `json`, `.trec` -> `trec`, `.txt` -> `trec`, `.parq` -> `parquet`, `.parquet` -> `parquet`. Use the `kind` argument to override the default behavior. ```python From 95312a0af0d4fff1bd76eb6f04611d429521e57b Mon Sep 17 00:00:00 2001 From: Imad Saddik <79410781+ImadSaddik@users.noreply.github.com> Date: Sat, 13 Sep 2025 11:23:37 +0100 Subject: [PATCH 4/5] Fixed a broken link and a typo in index.md --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5f7edc0..9f7f65f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,7 +31,7 @@ Any dependence on `trec_eval` have been removed to make `ranx` truly MIT-complia It offers a user-friendly interface to evaluate and compare [Information Retrieval](https://en.wikipedia.org/wiki/Information_retrieval) and [Recommender Systems](https://en.wikipedia.org/wiki/Recommender_system). [ranx](https://github.com/AmenRa/ranx) allows you to perform statistical tests and export [LaTeX](https://en.wikipedia.org/wiki/LaTeX) tables for your scientific publications. Moreover, [ranx](https://github.com/AmenRa/ranx) provides several [fusion algorithms](https://amenra.github.io/ranx/fusion) and [normalization strategies](https://amenra.github.io/ranx/normalization), and an automatic [fusion optimization](https://amenra.github.io/ranx/fusion/#optimize-fusion) functionality. -[ranx](https://github.com/AmenRa/ranx) also have a companion repository of pre-computed runs to facilitated model comparisons called [ranxhub](https://amenra.github.io/ranxhub). +[ranx](https://github.com/AmenRa/ranx) also have a companion repository of pre-computed runs to facilitate model comparisons called [ranxhub](https://amenra.github.io/ranxhub). On [ranxhub](https://amenra.github.io/ranxhub), you can download and share pre-computed runs for Information Retrieval datasets, such as [MSMARCO Passage Ranking](https://arxiv.org/abs/1611.09268). [ranx](https://github.com/AmenRa/ranx) was featured in [ECIR 2022](https://ecir2022.org), [CIKM 2022](https://www.cikm2022.org), and [SIGIR 2023](https://sigir.org/sigir2023). @@ -91,7 +91,7 @@ A full list of the available runs is provided [here](https://amenra.github.io/ra | [CombMED](https://amenra.github.io/ranx/fusion/#combmed) | [CombGMNZ](https://amenra.github.io/ranx/fusion/#combgmnz) | [RBC](https://amenra.github.io/ranx/fusion/#rank-biased-centroids-rbc) | [PosFuse](https://amenra.github.io/ranx/fusion/#posfuse) | [Weighted BordaFuse](https://amenra.github.io/ranx/fusion/#weighted-bordafuse) | | [CombANZ](https://amenra.github.io/ranx/fusion/#combanz) | [ISR](https://amenra.github.io/ranx/fusion/#isr) | [WMNZ](https://amenra.github.io/ranx/fusion/#wmnz) | [ProbFuse](https://amenra.github.io/ranx/fusion/#probfuse) | [Condorcet](https://amenra.github.io/ranx/fusion/#condorcet) | | [CombMAX](https://amenra.github.io/ranx/fusion/#combmax) | [Log_ISR](https://amenra.github.io/ranx/fusion/#log_isr) | [Mixed](https://amenra.github.io/ranx/fusion/#mixed) | [SegFuse](https://amenra.github.io/ranx/fusion/#segfuse) | [Weighted Condorcet](https://amenra.github.io/ranx/fusion/#weighted-condorcet) | -| [CombSUM](https://amenra.github.io/ranx/fusion/#combsum) | [LogN_ISR](https://amenra.github.io/ranx/fusion/#logn_isr) | [BayesFuse](https://amenra.github.io/ranx/fusion/#bayesfuse) | [SlideFuse](https://amenra.github.io/ranx/fusion/#slidefuse) | [Weighted Sum](https://amenra.github.io/ranx/fusion/#wighted-sum) | +| [CombSUM](https://amenra.github.io/ranx/fusion/#combsum) | [LogN_ISR](https://amenra.github.io/ranx/fusion/#logn_isr) | [BayesFuse](https://amenra.github.io/ranx/fusion/#bayesfuse) | [SlideFuse](https://amenra.github.io/ranx/fusion/#slidefuse) | [Weighted Sum](https://amenra.github.io/ranx/fusion/#weighted-sum) | Please, refer to the [documentation](https://amenra.github.io/ranx/fusion) for further details. From 1ae279e4d4e0832445240674839434b91a4eec9f Mon Sep 17 00:00:00 2001 From: Imad Saddik <79410781+ImadSaddik@users.noreply.github.com> Date: Sat, 13 Sep 2025 11:29:41 +0100 Subject: [PATCH 5/5] Fixed a typo in the LogN_ISR section in fusion.md --- docs/fusion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fusion.md b/docs/fusion.md index 18ccbc3..faca7b9 100644 --- a/docs/fusion.md +++ b/docs/fusion.md @@ -335,7 +335,7 @@ Computes Log_ISR as proposed by [Mourão et al.](https://www.sciencedirect.com/s ### LogN_ISR -Computes Log_ISR as proposed by [Mourão et al.](https://www.sciencedirect.com/science/article/abs/pii/S0895611114000664). +Computes LogN_ISR as proposed by [Mourão et al.](https://www.sciencedirect.com/science/article/abs/pii/S0895611114000664).
BibTeX ```bibtex