fix documentation

experimaestro · May 31, 2024 · b2c5875 · b2c5875
1 parent ed2f0ef
commit b2c5875
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/docs/source/api/conversation.rst b/docs/source/api/conversation.rst
@@ -45,3 +45,11 @@ Contextual query reformulation
 
 .. autoclass:: datamaestro_text.data.conversation.orconvqa.OrConvQADatasetHistoryEntry
     :members:
+
+
+
+.. autoclass:: datamaestro_text.data.conversation.orconvqa.QReCCDatasetEntry
+    :members:
+
+.. autoxpmconfig:: datamaestro_text.data.conversation.qrecc.QReCCDataset
+    :members: iter
diff --git a/docs/source/datasets/conversation.rst b/docs/source/datasets/conversation.rst
@@ -8,3 +8,5 @@ Contextualized Query Rewriting
 .. dm:datasets:: com.github.aagohary.canard text
 
 .. dm:datasets:: com.github.prdwb.orconvqa text
+
+.. dm:datasets:: com.github.apple.ml-qrecc text
diff --git a/docs/source/datasets/irds.rst b/docs/source/datasets/irds.rst
@@ -8,9 +8,10 @@ version of `ir-datasets` is more ancient or newer than the one used at generatio
 Data types
 ----------
 
-.. autoxpmconfig:: xpmir.datasets.irds.data.Topics
-.. autoxpmconfig:: xpmir.datasets.irds.data.Documents
-.. autoxpmconfig:: xpmir.datasets.irds.data.AdhocAssessments
+.. autoxpmconfig:: datamaestro_text.datasets.irds.data.Topics
+.. autoxpmconfig:: datamaestro_text.datasets.irds.data.Documents
+.. autoxpmconfig:: datamaestro_text.datasets.irds.data.AdhocAssessments
+.. autoxpmconfig:: datamaestro_text.datasets.irds.data.LZ4DocumentStore
 
 
 List of datasets

diff --git a/src/datamaestro_text/data/conversation/qrecc.py b/src/datamaestro_text/data/conversation/qrecc.py
@@ -1,4 +1,3 @@
-from functools import cached_property
 from typing import Iterator, List, Optional
 from attr import define
 import json
@@ -16,7 +15,6 @@
     AnswerEntry,
     ConversationTree,
     EntryType,
-    RetrievedEntry,
     SimpleDecontextualizedItem,
     SingleConversationTree,
 )
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,3 +8,5 @@ Contextualized Query Rewriting
		.. dm:datasets:: com.github.aagohary.canard text

		.. dm:datasets:: com.github.prdwb.orconvqa text

		.. dm:datasets:: com.github.apple.ml-qrecc text