doc: document a bit more

experimaestro · Dec 4, 2023 · d36eb9c · d36eb9c
1 parent eeb8aa9
commit d36eb9c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/xpmir/letor/samplers/hydrators.py b/src/xpmir/letor/samplers/hydrators.py
@@ -46,6 +46,14 @@ def transform_documents(self, documents: List[ir.Document]):
 
 
 class PairwiseTransformAdapter(PairwiseSampler):
+    """Transforms pairwise samples using an adapter
+
+    It is interesting to use this adapter since the transformation is only
+    performed if the samples are used: when using a SkippingIterator, when
+    recovering a checkpoint, all the records might have to be processed
+    otherwise.
+    """
+
     sampler: Param[PairwiseSampler]
     """The distillation samples without texts for query and documents"""
 

diff --git a/src/xpmir/neural/cross.py b/src/xpmir/neural/cross.py
@@ -54,8 +54,9 @@ def distribute_models(self, update):
 
 
 class DuoCrossScorer(DuoLearnableScorer, DistributableModel):
-    """Query-document-document Representation classifier based on Bert
-    The encoder usually refer to the encoder of type DualDuoBertTransformerEncoder()
+    """Preference based classifier
+
+    This scorer can be used to train a DuoBERT-type model.
     """
 
     encoder: Param[TripletTextEncoder]