rename utility function

Lightning-AI · Jun 2, 2020 · ea9fab3 · ea9fab3
1 parent 47b4693
commit ea9fab3
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/pytorch_lightning/core/hooks.py b/pytorch_lightning/core/hooks.py
@@ -3,7 +3,7 @@
 import torch
 from torch import Tensor
 from torch.optim.optimizer import Optimizer
-from pytorch_lightning.utilities import transfer_batch_to_device
+from pytorch_lightning.utilities import move_data_to_device
 
 
 try:
@@ -196,7 +196,7 @@ def transfer_batch_to_device(self, batch, device)
             batch and determines the target devices.
 
         See Also:
-            - :func:`~pytorch_lightning.utilities.apply_func.transfer_batch_to_device`
+            - :func:`~pytorch_lightning.utilities.apply_func.move_data_to_device`
             - :func:`~pytorch_lightning.utilities.apply_func.apply_to_collection`
         """
-        return transfer_batch_to_device(batch, device)
+        return move_data_to_device(batch, device)
diff --git a/pytorch_lightning/trainer/distrib_parts.py b/pytorch_lightning/trainer/distrib_parts.py
@@ -18,7 +18,7 @@
     LightningDistributedDataParallel,
     LightningDataParallel,
 )
-from pytorch_lightning.utilities import transfer_batch_to_device
+from pytorch_lightning.utilities import move_data_to_device
 from pytorch_lightning.utilities.exceptions import MisconfigurationException
 from pytorch_lightning.utilities.distributed import rank_zero_only
 
@@ -112,7 +112,7 @@ def transfer_batch_to_tpu(self, batch: Any, tpu_id: Optional[int] = None):
             the tensor on the TPU device.
 
         See Also:
-            - :func:`~pytorch_lightning.utilities.apply_func.transfer_batch_to_device`
+            - :func:`~pytorch_lightning.utilities.apply_func.move_data_to_device`
         """
         if not XLA_AVAILABLE:
             raise MisconfigurationException(
@@ -134,7 +134,7 @@ def transfer_batch_to_gpu(self, batch: Any, gpu_id: Optional[int] = None):
             the tensor on the GPU device.
 
         See Also:
-            - :func:`~pytorch_lightning.utilities.apply_func.transfer_batch_to_device`
+            - :func:`~pytorch_lightning.utilities.apply_func.move_data_to_device`
         """
         device = torch.device('cuda', gpu_id)
         return self.__transfer_batch_to_device(batch, device)
@@ -143,7 +143,7 @@ def __transfer_batch_to_device(self, batch: Any, device: torch.device):
         model = self.get_model()
         if model is not None:
             return model.transfer_batch_to_device(batch, device)
-        return transfer_batch_to_device(batch, device)
+        return move_data_to_device(batch, device)
 
     def single_gpu_train(self, model):
         model.cuda(self.root_gpu)

diff --git a/pytorch_lightning/utilities/__init__.py b/pytorch_lightning/utilities/__init__.py
@@ -1,4 +1,4 @@
 """General utilities"""
 
 from pytorch_lightning.utilities.distributed import rank_zero_only, rank_zero_warn
-from pytorch_lightning.utilities.apply_func import transfer_batch_to_device
+from pytorch_lightning.utilities.apply_func import move_data_to_device
diff --git a/pytorch_lightning/utilities/apply_func.py b/pytorch_lightning/utilities/apply_func.py
@@ -38,7 +38,7 @@ def apply_to_collection(data: Any, dtype: Union[type, tuple], function: Callable
     return data
 
 
-def transfer_batch_to_device(batch: Any, device: torch.device):
+def move_data_to_device(batch: Any, device: torch.device):
     """
     Transfers a collection of tensors to the given device.