Skip to content

Commit 507003f

Browse files
committed
rename functions + deprecated old names
1 parent 06eabe7 commit 507003f

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

ot/datasets.py

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
import numpy as np
1111
import scipy as sp
12-
from .utils import check_random_state
12+
from .utils import check_random_state, deprecated
1313

1414

1515
def get_1D_gauss(n, m, s):
@@ -37,14 +37,14 @@ def get_1D_gauss(n, m, s):
3737
return h / h.sum()
3838

3939

40-
def get_2D_samples_gauss(n, m, sigma, random_state=None):
40+
def make_2D_samples_gauss(n, m, sigma, random_state=None):
4141
"""return n samples drawn from 2D gaussian N(m,sigma)
4242
4343
Parameters
4444
----------
4545
4646
n : int
47-
number of bins in the histogram
47+
number of samples to make
4848
m : np.array (2,)
4949
mean value of the gaussian distribution
5050
sigma : np.array (2,2)
@@ -73,7 +73,13 @@ def get_2D_samples_gauss(n, m, sigma, random_state=None):
7373
return res
7474

7575

76-
def get_data_classif(dataset, n, nz=.5, theta=0, random_state=None, **kwargs):
76+
@deprecated()
77+
def get_2D_samples_gauss(n, m, sigma, random_state=None):
78+
""" Deprecated see make_2D_samples_gauss """
79+
return make_2D_samples_gauss(n, m, sigma, random_state=None)
80+
81+
82+
def make_data_classif(dataset, n, nz=.5, theta=0, random_state=None, **kwargs):
7783
""" dataset generation for classification problems
7884
7985
Parameters
@@ -152,3 +158,9 @@ def get_data_classif(dataset, n, nz=.5, theta=0, random_state=None, **kwargs):
152158
print("unknown dataset")
153159

154160
return x, y.astype(int)
161+
162+
163+
@deprecated()
164+
def get_data_classif(dataset, n, nz=.5, theta=0, random_state=None, **kwargs):
165+
""" Deprecated see make_data_classif """
166+
return make_data_classif(dataset, n, nz=.5, theta=0, random_state=None, **kwargs)

0 commit comments

Comments
 (0)