Deprecating the DominantFrequencyChange check (#1685)

deepchecks/tabular/checks/train_test_validation/dominant_frequency_change.py

@@ -9,6 +9,7 @@
 # ----------------------------------------------------------------------------
 #
 """module contains Dominant Frequency Change check."""
+import warnings
 from typing import Dict, Optional
 
 import numpy as np
@@ -28,6 +29,9 @@
 class DominantFrequencyChange(TrainTestCheck):
     """Check if dominant values have increased significantly between test and reference data.
 
+    .. deprecated:: 0.8.1
+        The DominantFrequencyChange check is deprecated and will be removed in the 0.11 version.
+
     Parameters
     ----------
     dominance_ratio : float , default: 2
@@ -50,6 +54,9 @@ def __init__(
         self.ratio_change_thres = ratio_change_thres
         self.n_top_columns = n_top_columns
 
+        warnings.warn('The DominantFrequencyChange check is deprecated and will be removed in the 0.11 version.',
+                      DeprecationWarning)
+
     def run_logic(self, context: Context) -> CheckResult:
         """Run check.
 

deepchecks/tabular/deprecation_warnings.py

@@ -86,3 +86,10 @@
     category=DeprecationWarning,
     module=r'deepchecks.*'
 )
+
+warnings.filterwarnings(
+    action='once',
+    message=r'The DominantFrequencyChange check is deprecated.*',
+    category=DeprecationWarning,
+    module=r'deepchecks.*'
+)

tests/base/test_tabular_deprecation_warnings.py

@@ -15,7 +15,7 @@
 import pytest
 
 from deepchecks.tabular.checks import (TrainTestFeatureDrift, TrainTestLabelDrift, TrainTestPredictionDrift,
-                                       WholeDatasetDrift)
+                                       WholeDatasetDrift, DominantFrequencyChange)
 
 
 def test_deprecation_warning_label_drift():
@@ -60,3 +60,9 @@ def test_deprecation_warning_whole_dataset_drift():
     with warnings.catch_warnings():
         warnings.simplefilter('error')
         _ = WholeDatasetDrift()
+
+
+def test_deprecation_dominant_freq_change_warning():
+    # Test that warning is raised when max_num_categories has value:
+    with pytest.warns(DeprecationWarning, match='The DominantFrequencyChange check is deprecated'):
+        _ = DominantFrequencyChange()