Warnings for n_constrains

Author: mvargas33

metric_learn/constraints.py

@@ -6,6 +6,7 @@
 import warnings
 from sklearn.utils import check_random_state
 from sklearn.neighbors import NearestNeighbors
+import warnings
 
 __all__ = ['Constraints']
 
@@ -32,7 +33,7 @@ def __init__(self, partial_labels):
     self.partial_labels = partial_labels
 
   def positive_negative_pairs(self, n_constraints, same_length=False,
-                              random_state=None):
+                              random_state=None, num_constraints='deprecated'):
     """
     Generates positive pairs and negative pairs from labeled data.
 
@@ -55,6 +56,8 @@ def positive_negative_pairs(self, n_constraints, same_length=False,
     random_state : int or numpy.RandomState or None, optional (default=None)
       A pseudo random number generator object or a seed for it if int.
 
+    num_constraints : Renamed to n_constrains. Will be deprecated 0.7.0
+
     Returns
     -------
     a : array-like, shape=(n_constraints,)
@@ -69,6 +72,12 @@ def positive_negative_pairs(self, n_constraints, same_length=False,
     d : array-like, shape=(n_constraints,)
       1D array of indicators for the right elements of negative pairs.
     """
+    if self.num_constraints != 'deprecated':
+      warnings.warn('"num_constraints" parameter has been renamed to '
+                    '"n_constraints". It has been deprecated in'
+                    ' version 0.6.3 and will be removed in 0.7.0'
+                    '', FutureWarning)
+      self.n_constraints = num_constraints
     random_state = check_random_state(random_state)
     a, b = self._pairs(n_constraints, same_label=True,
                        random_state=random_state)