runif consistency (#17686)

src/lightning/fabric/utilities/testing/__init__.py

@@ -1,3 +1,3 @@
-from lightning.fabric.utilities.testing._runif import _RunIf
+from lightning.fabric.utilities.testing._runif import _runif_reasons
 
-__all__ = ["_RunIf"]
+__all__ = ["_runif_reasons"]

src/lightning/fabric/utilities/testing/_runif.py

@@ -27,7 +27,7 @@
 from lightning.fabric.utilities.imports import _TORCH_GREATER_EQUAL_2_1
 
 
-def _RunIf(
+def _runif_reasons(
     *,
     min_cuda_gpus: int = 0,
     min_torch: Optional[str] = None,
@@ -41,7 +41,8 @@ def _RunIf(
     deepspeed: bool = False,
     dynamo: bool = False,
 ) -> Tuple[List[str], Dict[str, bool]]:
-    """
+    """Construct reasons for pytest skipif.
+
     Args:
         min_cuda_gpus: Require this number of gpus and that the ``PL_RUN_CUDA_TESTS=1`` environment variable is set.
         min_torch: Require that PyTorch is greater or equal than this version.

src/lightning/pytorch/utilities/testing/__init__.py

@@ -1,3 +1,3 @@
-from lightning.pytorch.utilities.testing._runif import _RunIf
+from lightning.pytorch.utilities.testing._runif import _runif_reasons
 
-__all__ = ["_RunIf"]
+__all__ = ["_runif_reasons"]

src/lightning/pytorch/utilities/testing/_runif.py

@@ -16,7 +16,7 @@
 from lightning_utilities.core.imports import RequirementCache
 
 from lightning.fabric.utilities.imports import _TORCH_GREATER_EQUAL_2_0
-from lightning.fabric.utilities.testing import _RunIf as FabricRunIf
+from lightning.fabric.utilities.testing import _runif_reasons as FabricRunIf
 from lightning.pytorch.accelerators.cpu import _PSUTIL_AVAILABLE
 from lightning.pytorch.callbacks.progress.rich_progress import _RICH_AVAILABLE
 from lightning.pytorch.core.module import _ONNX_AVAILABLE
@@ -25,7 +25,7 @@
 _SKLEARN_AVAILABLE = RequirementCache("scikit-learn")
 
 
-def _RunIf(
+def _runif_reasons(
     *,
     min_cuda_gpus: int = 0,
     min_torch: Optional[str] = None,
@@ -44,7 +44,7 @@ def _RunIf(
     sklearn: bool = False,
     onnx: bool = False,
 ) -> Tuple[List[str], Dict[str, bool]]:
-    """Internal wrapper for filtering test cases.
+    """Construct reasons for pytest skipif.
 
     Args:
         min_cuda_gpus: Require this number of gpus and that the ``PL_RUN_CUDA_TESTS=1`` environment variable is set.

tests/tests_fabric/helpers/runif.py

@@ -13,9 +13,9 @@
 # limitations under the License.
 import pytest
 
-from lightning.fabric.utilities.testing import _RunIf
+from lightning.fabric.utilities.testing import _runif_reasons
 
 
 def RunIf(**kwargs):
-    reasons, marker_kwargs = _RunIf(**kwargs)
+    reasons, marker_kwargs = _runif_reasons(**kwargs)
     return pytest.mark.skipif(condition=len(reasons) > 0, reason=f"Requires: [{' + '.join(reasons)}]", **marker_kwargs)

tests/tests_pytorch/helpers/pipelines.py

@@ -51,6 +51,7 @@ def run_model_test(
     version=None,
     with_hpc: bool = True,
     min_acc: float = 0.25,
+    min_change_ratio: float = 0.03,
 ):
     save_dir = trainer_options["default_root_dir"]
 
@@ -65,7 +66,7 @@ def run_model_test(
     assert trainer.state.finished, f"Training failed with {trainer.state}"
     # Check that the model is actually changed post-training
     change_ratio = torch.norm(initial_values - post_train_values)
-    assert change_ratio > 0.03, f"the model is changed of {change_ratio}"
+    assert change_ratio >= min_change_ratio, f"the model is changed of {change_ratio} and shall be >={min_change_ratio}"
 
     # test model loading
     _ = load_model_from_checkpoint(trainer.checkpoint_callback.best_model_path, type(model))

tests/tests_pytorch/helpers/runif.py

@@ -13,9 +13,9 @@
 # limitations under the License.
 import pytest
 
-from lightning.pytorch.utilities.testing import _RunIf
+from lightning.pytorch.utilities.testing import _runif_reasons
 
 
 def RunIf(**kwargs):
-    reasons, marker_kwargs = _RunIf(**kwargs)
+    reasons, marker_kwargs = _runif_reasons(**kwargs)
     return pytest.mark.skipif(condition=len(reasons) > 0, reason=f"Requires: [{' + '.join(reasons)}]", **marker_kwargs)

tests/tests_pytorch/models/test_cpu.py

@@ -114,7 +114,7 @@ def validation_step(self, *args, **kwargs):
         "gradient_clip_val": 1.0,
         "enable_progress_bar": False,
         "accumulate_grad_batches": 2,
-        "limit_train_batches": 0.1,
+        "limit_train_batches": 0.3,
         "limit_val_batches": 0.1,
     }