add device to data convertor class doc

This commit is contained in:
Yinon Polak 2023-04-03 16:36:38 +03:00
parent 36a0a14a23
commit bc9454e0f9

View File

@ -11,7 +11,7 @@ class PyTorchDataConvertor(ABC):
def convert_x(self, df: pd.DataFrame, device: Optional[str] = None) -> Tuple[torch.Tensor, ...]: def convert_x(self, df: pd.DataFrame, device: Optional[str] = None) -> Tuple[torch.Tensor, ...]:
""" """
:param df: "*_features" dataframe. :param df: "*_features" dataframe.
:param device: cpu/gpu. :param device: The device to use for training (e.g. 'cpu', 'cuda').
:returns: tuple of tensors. :returns: tuple of tensors.
""" """
@ -19,7 +19,7 @@ class PyTorchDataConvertor(ABC):
def convert_y(self, df: pd.DataFrame, device: Optional[str] = None) -> Tuple[torch.Tensor, ...]: def convert_y(self, df: pd.DataFrame, device: Optional[str] = None) -> Tuple[torch.Tensor, ...]:
""" """
:param df: "*_labels" dataframe. :param df: "*_labels" dataframe.
:param device: cpu/gpu. :param device: The device to use for training (e.g. 'cpu', 'cuda').
:returns: tuple of tensors. :returns: tuple of tensors.
""" """