Don't allow both indices_tuple and enqueue_idx

Author: KevinMusgrave

src/pytorch_metric_learning/losses/cross_batch_memory.py

@@ -18,6 +18,8 @@ def __init__(self, loss, embedding_size, memory_size=1024, miner=None, **kwargs)
         )
 
     def forward(self, embeddings, labels, indices_tuple=None, enqueue_idx=None):
+        if indices_tuple is not None and enqueue_idx is not None:
+            raise ValueError("indices_tuple and enqueue_idx are mutually exclusive")
         if enqueue_idx is not None:
             assert len(enqueue_idx) <= len(self.embedding_memory)
             assert len(enqueue_idx) < len(embeddings)

tests/utils/test_distributed.py

@@ -358,17 +358,15 @@ def test_distributed_tuple_loss_and_miner(self):
                 for pass_labels_to_loss_fn in [False, True]:
                     if xbm and use_ref or xbm and not pass_labels_to_loss_fn:
                         continue
-                    for use_xbm_enqueue_idx in [False, True]:
-                        self.loss_and_miner_tester(
-                            ContrastiveLoss,
-                            PairMarginMiner,
-                            False,
-                            xbm,
-                            use_ref,
-                            miner_kwargs={"pos_margin": 0.5, "neg_margin": 0.5},
-                            pass_labels_to_loss_fn=pass_labels_to_loss_fn,
-                            use_xbm_enqueue_idx=use_xbm_enqueue_idx,
-                        )
+                    self.loss_and_miner_tester(
+                        ContrastiveLoss,
+                        PairMarginMiner,
+                        False,
+                        xbm,
+                        use_ref,
+                        miner_kwargs={"pos_margin": 0.5, "neg_margin": 0.5},
+                        pass_labels_to_loss_fn=pass_labels_to_loss_fn,
+                    )
 
     def test_distributed_tuple_loss_efficient(self):
         for use_ref in [False, True]: