ir_datasets documentation

experimaestro · Dec 12, 2023 · 3b21b15 · 3b21b15
1 parent ef5317c
commit 3b21b15
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/source/datasets/irds.rst b/docs/source/datasets/irds.rst
@@ -0,0 +1,19 @@
+IR Datasets
+===========
+
+XPMIR provides an interface to the `IR Datasets <https://ir-datasets.com/>`_ library.
+The list below is provided as a reference, but might not be up-to-date if your
+version of `ir-datasets` is more ancient or newer than the one used at generation time.
+
+Data types
+----------
+
+.. autoxpmconfig:: xpmir.datasets.irds.data.Topics
+.. autoxpmconfig:: xpmir.datasets.irds.data.Documents
+.. autoxpmconfig:: xpmir.datasets.irds.data.AdhocAssessments
+
+
+List of datasets
+----------------
+
+.. dm:repository:: irds