proportion parameter query

docs/release_history.rst

@@ -1,6 +1,11 @@
 Release History
 ***************
 
+Version 0.7.1 (2022.09.16.)
+===========================
+
+* Query for oversamplers with `proportion` parameter added.
+
 Version 0.7.0 (2022.09.11.)
 ===========================
 

smote_variants/_version.py

@@ -6,4 +6,4 @@
 @author: gykovacs
 """
 
-__version__= '0.7.0'
+__version__= '0.7.1'

smote_variants/queries/_queries.py

@@ -29,6 +29,7 @@
           'get_metric_learning_oversamplers',
           'get_simplex_sampling_oversamplers',
           'get_multiclass_oversamplers',
+          'get_proportion_oversamplers',
           'get_all_noisefilters',
           'generate_parameter_combinations']
 
@@ -91,6 +92,25 @@ def get_all_oversamplers(n_quickest=-1):
 
     return determine_n_quickest(oversamplers, n_quickest)
 
+def get_proportion_oversamplers(n_quickest=-1):
+    """
+    Returns all oversamplers having a proportion parameter to control the number
+    of samples to be generated.
+
+    Args:
+        n_quickest (int): the number of quickest oversamplers to return
+
+    Returns:
+        list(OverSampling): the list of oversampling classes having a proportion
+                            parameter
+    """
+
+    oversamplers = get_all_oversamplers()
+
+    oversamplers = [o for o in oversamplers if 'proportion' in o().get_params()]
+
+    return determine_n_quickest(oversamplers, n_quickest)
+
 def get_metric_learning_oversamplers(n_quickest=-1):
     """
     Returns all oversampling classes supporting the use of metric learning

tests/test_queries.py

@@ -11,6 +11,7 @@ def test_queries():
     assert len(sv.get_all_oversamplers()) >= 0
     assert len(sv.get_all_oversamplers(n_quickest=2)) == 2
     assert len(sv.get_all_noisefilters()) >= 0
+    assert len(sv.get_proportion_oversamplers()) >= 0
     assert len(sv.get_multiclass_oversamplers()) >= 0
     assert len(sv.get_multiclass_oversamplers(n_quickest=2)) == 2
     assert len(sv.get_metric_learning_oversamplers()) >= 0