10000 MNT Make utils.weight_vector and utils.seq_dataset private (#15225) · crankycoder/scikit-learn@150e82b · GitHub
[go: up one dir, main page]

Skip to content

Commit 150e82b

Browse files
NicolasHugrth
authored andcommitted
MNT Make utils.weight_vector and utils.seq_dataset private (scikit-learn#15225)
1 parent 1e77619 commit 150e82b

File tree

12 files changed

+24
-17
lines changed

12 files changed

+24
-17
lines changed

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,12 @@ _configtest.o.d
7373
.mypy_cache/
7474

7575
# files generated from a template
76-
sklearn/utils/seq_dataset.pyx
77-
sklearn/utils/seq_dataset.pxd
76+
sklearn/utils/_seq_dataset.pyx
77+
sklearn/utils/_seq_dataset.pxd
7878
sklearn/linear_model/sag_fast.pyx
7979

8080
# deprecated paths
8181
# TODO: Remove in 0.24
8282
sklearn/utils/mocking.py
83+
sklearn/utils/weight_vector.py
84+
sklearn/utils/seq_dataset.py

sklearn/_build_utils/deprecated_modules.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
# (new_module_name, deprecated_path, correct_import_path)
88
_DEPRECATED_MODULES = {
99
# TODO: Remove in 0.24
10-
('_mocking', 'sklearn.utils.mocking', 'sklearn.utils')
10+
('_mocking', 'sklearn.utils.mocking', 'sklearn.utils'),
11+
12+
('_weight_vector', 'sklearn.utils.weight_vector', 'sklearn.utils'),
13+
('_seq_dataset', 'sklearn.utils.seq_dataset', 'sklearn.utils'),
1114
}
1215

1316
_FILE_CONTENT_TEMPLATE = """from .{new_module_name} import * # noqa

sklearn/linear_model/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
from ..utils.extmath import safe_sparse_dot
3333
from ..utils.sparsefuncs import mean_variance_axis, inplace_column_scale
3434
from ..utils.fixes import sparse_lsqr
35-
from ..utils.seq_dataset import ArrayDataset32, CSRDataset32
36-
from ..utils.seq_dataset import ArrayDataset64, CSRDataset64
35+
from ..utils._seq_dataset import ArrayDataset32, CSRDataset32
36+
from ..utils._seq_dataset import ArrayDataset64, CSRDataset64
3737
from ..utils.validation import check_is_fitted
3838
from ..preprocessing.data import normalize as f_normalize
3939

sklearn/linear_model/sag_fast.pyx.tp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ from libc.time cimport time, time_t
5454
from .sgd_fast cimport LossFunction
5555
from .sgd_fast cimport Log, SquaredLoss
5656

57-
from ..utils.seq_dataset cimport SequentialDataset32, SequentialDataset64
57+
from ..utils._seq_dataset cimport SequentialDataset32, SequentialDataset64
5858

5959
from libc.stdio cimport printf
6060

sklearn/linear_model/sgd_fast.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ from numpy.math cimport INFINITY
2121
cdef extern from "sgd_fast_helpers.h":
2222
bint skl_isfinite(double) nogil
2323

24-
from ..utils.weight_vector cimport WeightVector
25-
from ..utils.seq_dataset cimport SequentialDataset64 as SequentialDataset
24+
from ..utils._weight_vector cimport WeightVector
25+
from ..utils._seq_dataset cimport SequentialDataset64 as SequentialDataset
2626

2727
np.import_array()
2828

sklearn/tests/test_import_deprecations.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
('sklearn.neural_network.multilayer_perceptron', 'MLPClassifier'),
1616
1717
('sklearn.utils.mocking', 'MockDataFrame'),
18+
('sklearn.utils.weight_vector', 'WeightVector'),
19+
('sklearn.utils.seq_dataset', 'ArrayDataset32'),
1820
))
1921
def test_import_is_deprecated(deprecated_path, importee):
2022
# Make sure that "from deprecated_path import importee" is still possible

sklearn/utils/seq_dataset.pxd.tp renamed to sklearn/utils/_seq_dataset.pxd.tp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Dataset abstractions for sequential data access.
66
Template file for easily generate fused types consistent code using Tempita
77
(https://github.com/cython/cython/blob/master/Cython/Tempita/_tempita.py).
88

9-
Generated file: seq_dataset.pxd
9+
Generated file: _seq_dataset.pxd
1010

1111
Each class is duplicated for all dtypes (float and double). The keywords
1212
between double braces are substituted in setup.py.

sklearn/utils/seq_dataset.pyx.tp renamed to sklearn/utils/_seq_dataset.pyx.tp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Dataset abstractions for sequential data access.
88
Template file for easily generate fused types consistent code using Tempita
99
(https://github.com/cython/cython/blob/master/Cython/Tempita/_tempita.py).
1010

11-
Generated file: seq_dataset.pyx
11+
Generated file: _seq_dataset.pyx
1212

1313
Each class is duplicated for all dtypes (float and double). The keywords
1414
between double braces are substituted in setup.py.
File renamed without changes.
File renamed without changes.

sklearn/utils/setup.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ def configuration(parent_package='', top_path=None):
4242
libraries=libraries)
4343

4444
# generate files from a template
45-
pyx_templates = ['sklearn/utils/seq_dataset.pyx.tp',
46-
'sklearn/utils/seq_dataset.pxd.tp']
45+
pyx_templates = ['sklearn/utils/_seq_dataset.pyx.tp',
46+
'sklearn/utils/_seq_dataset.pxd.tp']
4747

4848
for pyxfiles in pyx_templates:
4949
outfile = pyxfiles.replace('.tp', '')
@@ -59,12 +59,12 @@ def configuration(parent_package='', top_path=None):
5959
with open(outfile, "w") as f:
6060
f.write(pyxcontent)
6161

62-
config.add_extension('seq_dataset',
63-
sources=['seq_dataset.pyx'],
62+
config.add_extension('_seq_dataset',
63+
sources=['_seq_dataset.pyx'],
6464
include_dirs=[numpy.get_include()])
6565

66-
config.add_extension('weight_vector',
67-
sources=['weight_vector.pyx'],
66+
config.add_extension('_weight_vector',
67+
sources=['_weight_vector.pyx'],
6868
include_dirs=[numpy.get_include()],
6969
libraries=libraries)
7070

sklearn/utils/tests/test_seq_dataset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import pytest
88
import scipy.sparse as sp
99
from numpy.testing import assert_array_equal
10-
from sklearn.utils.seq_dataset import (
10+
from sklearn.utils._seq_dataset import (
1111
ArrayDataset32, ArrayDataset64, CSRDataset32, CSRDataset64)
1212

1313
from sklearn.datasets import load_iris

0 commit comments

Comments
 (0)
0