_get_enable_gpu_value

Author: R-Palazzo

deepecho/models/_utils.py

@@ -4,7 +4,7 @@
 import torch
 
 
-def _validate_gpu_parameters(enable_gpu, cuda):
+def _get_enable_gpu_value(enable_gpu, cuda):
     """Validate both the `enable_gpu` and `cuda` parameters.
 
     The logic here is to:
@@ -48,5 +48,5 @@ def _set_device(enable_gpu):
 
 def validate_and_set_device(enable_gpu, cuda):
     """Validate the GPU parameters and set the torch device accordingly."""
-    enable_gpu = _validate_gpu_parameters(enable_gpu, cuda)
+    enable_gpu = _get_enable_gpu_value(enable_gpu, cuda)
     return _set_device(enable_gpu)

deepecho/models/basic_gan.py

@@ -140,11 +140,11 @@ class BasicGANModel(DeepEcho):
         enable_gpu (bool):
             Whether to attempt to use GPU for computation.
             Defaults to ``True``.
+        verbose (bool):
+            Whether to print progress to console or not.
         cuda (bool):
             **Deprecated** Whether to attempt to use cuda for GPU computation.
             If this is False or CUDA is not available, CPU will be used.
-        verbose (bool):
-            Whether to print progress to console or not.
     """
 
     _max_sequence_length = None
@@ -173,7 +173,6 @@ def __init__(
         self._latent_size = latent_size
         self._hidden_size = hidden_size
         self._device = validate_and_set_device(enable_gpu, cuda)
-        self._enable_gpu = cuda if cuda is not None else enable_gpu
         self._verbose = verbose
 
         LOGGER.info('%s instance created', self)

deepecho/models/par.py

@@ -91,19 +91,21 @@ class PARModel(DeepEcho):
             The number of times to sample (before choosing and
             returning the sample which maximizes the likelihood).
             Defaults to 1.
-        cuda (bool):
-            Whether to attempt to use cuda for GPU computation.
-            If this is False or CUDA is not available, CPU will be used.
+        enable_gpu (bool):
+            Whether to attempt to use GPU for computation.
             Defaults to ``True``.
         verbose (bool):
             Whether to print progress to console or not.
+        cuda (bool):
+            **Deprecated** Whether to attempt to use cuda for GPU computation.
+            If this is False or CUDA is not available, CPU will be used.
+            Defaults to ``True``.
     """
 
     def __init__(self, epochs=128, sample_size=1, enable_gpu=True, verbose=True, cuda=None):
         self.epochs = epochs
         self.sample_size = sample_size
         self.device = validate_and_set_device(enable_gpu=enable_gpu, cuda=cuda)
-        self._enable_gpu = cuda if cuda is not None else enable_gpu
         self.verbose = verbose
         self.loss_values = pd.DataFrame(columns=['Epoch', 'Loss'])
 

tests/integration/test_basic_gan.py

@@ -23,9 +23,7 @@ def test_deprecation_warning(self):
 
         # Run and Assert
         with pytest.warns(FutureWarning, match=expected_message):
-            model = BasicGANModel(epochs=10, cuda=False)
-
-        assert model._enable_gpu is False
+            BasicGANModel(epochs=10, cuda=False)
 
     def test__init___enable_gpu(self):
         """Test when `enable_gpu` parameter in the constructor."""
@@ -45,7 +43,6 @@ def test__init___enable_gpu(self):
             expected_device = torch.device('cpu')
 
         assert model._device == expected_device
-        assert model._enable_gpu is True
 
     def test_basic(self):
         """Basic test for the ``BasicGANModel``."""

tests/unit/models/test__utils.py

@@ -7,11 +7,11 @@
 import pytest
 import torch
 
-from deepecho.models._utils import _set_device, _validate_gpu_parameters, validate_and_set_device
+from deepecho.models._utils import _get_enable_gpu_value, _set_device, validate_and_set_device
 
 
-def test__validate_gpu_parameterss():
-    """Test the ``_validate_gpu_parameters`` method."""
+def test__get_enable_gpu_values():
+    """Test the ``_get_enable_gpu_value`` method."""
     # Setup
     expected_error = re.escape(
         'Cannot resolve the provided values of `cuda` and `enable_gpu` parameters. '
@@ -23,13 +23,13 @@ def test__validate_gpu_parameterss():
     )
 
     # Run
-    enable_gpu_1 = _validate_gpu_parameters(False, None)
-    enable_gpu_2 = _validate_gpu_parameters(True, None)
+    enable_gpu_1 = _get_enable_gpu_value(False, None)
+    enable_gpu_2 = _get_enable_gpu_value(True, None)
     with pytest.warns(FutureWarning, match=expected_warning):
-        enable_gpu_3 = _validate_gpu_parameters(True, False)
+        enable_gpu_3 = _get_enable_gpu_value(True, False)
 
     with pytest.raises(ValueError, match=expected_error):
-        _validate_gpu_parameters(False, True)
+        _get_enable_gpu_value(False, True)
 
     # Assert
     assert enable_gpu_1 is False
@@ -60,7 +60,7 @@ def test__set_device():
 
 
 @patch('deepecho.models._utils._set_device')
-@patch('deepecho.models._utils._validate_gpu_parameters')
+@patch('deepecho.models._utils._get_enable_gpu_value')
 def test_validate_and_set_device(mock_validate, mock_set_device):
     """Test the ``validate_and_set_device`` method."""
     # Setup