Adding doc-string to sample_from

Author: marcromeyn

merlin/models/torch/batch.py

@@ -134,6 +134,29 @@ def sample_from(
         batch_size: int = 32,
         shuffle: Optional[bool] = False,
     ) -> "Batch":
+        """Sample a batch from a dataset or a loader.
+
+        Example usage::
+            dataset = merlin.io.Dataset(...)
+            batch = Batch.sample_from(dataset)
+
+        Parameters
+        ----------
+        dataset_or_loader: merlin.io.dataset
+            A Dataset object or a Loader object.
+        batch_size: int, default=32
+            Number of samples to return.
+        shuffle: bool
+            Whether to sample a random batch or not, by default False.
+
+        Returns:
+        -------
+        features: Dict[torch.Tensor]
+            dictionary of feature tensors.
+        targets: Dict[torch.Tensor]
+            dictionary of target tensors.
+        """
+
         return sample_batch(dataset_or_loader, batch_size, shuffle)
 
     def replace(