Skip to content

Commit 9f6d88c

Browse files
committed
Hightlight more Nones
1 parent 6fdf046 commit 9f6d88c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/skmatter/metrics/_reconstruction_measures.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ def global_reconstruction_error(
110110
X use input shape (samples, features). For sample reconstruction of Y using X
111111
use input shape (features, samples).
112112
train_idx : numpy.ndarray, dtype=int, default=None
113-
Array of indices used for training. If None, the complement of the ``test_idx``
114-
is used. If ``train_size`` is also ``None``, 2-fold split is taken.
113+
Array of indices used for training. If ``None``, the complement of the
114+
``test_idx`` is used. If ``train_size`` is also ``None``, 2-fold split is taken.
115115
test_idx : numpy.ndarray, dtype=int, default=None
116-
Array of indices used for testing. If None, the complement of the ``train_idx``
117-
is used. If ``test_size`` is also None, 2-fold split is taken.
116+
Array of indices used for testing. If ``None``, the complement of the
117+
``train_idx`` is used. If ``test_size`` is also ``None``, 2-fold split is taken.
118118
scaler : object implementing fit/transform, default=``StandardFlexibleScaler``
119119
Scales X and Y before computing the reconstruction measure. The default value
120120
scales the features such that the reconstruction measure on the training set is
@@ -181,11 +181,11 @@ def pointwise_global_reconstruction_distortion(
181181
For feature reconstruction of Y using X use input shape (samples, features).
182182
For sample reconstruction of Y using X use input shape (features, samples).
183183
train_idx : numpy.ndarray, dtype=int, default=None
184-
Array of indices used for training. If None, the complement of the ``test_idx``
185-
is used. If ``train_size`` is also None, 2-fold split is taken.
184+
Array of indices used for training. If ``None``, the complement of the
185+
``test_idx`` is used. If ``train_size`` is also ``None``, 2-fold split is taken.
186186
test_idx : numpy.ndarray, dtype=int, default=None
187-
Array of indices used for testing. If None, the complement of the ``train_idx``
188-
is used. If ``test_size`` is also None, 2-fold split is taken.
187+
Array of indices used for testing. If ``None``, the complement of the
188+
``train_idx`` is used. If ``test_size`` is also ``None``, 2-fold split is taken.
189189
scaler : object implementing fit/transform, default=``StandardFlexibleScaler``
190190
Scales X and Y before computing the reconstruction measure. The default value
191191
scales the features such that the reconstruction measure on the training set is
@@ -254,10 +254,10 @@ def global_reconstruction_distortion(
254254
For sample reconstruction of Y using X use input shape (features, samples).
255255
train_idx : numpy.ndarray, dtype=int, default=None
256256
Array of indices used for training. If ``None``, the complement of the
257-
``test_idx`` is used. If ``train_size`` is also None, 2-fold split is taken.
257+
``test_idx`` is used. If ``train_size`` is also ``None``, 2-fold split is taken.
258258
test_idx : numpy.ndarray, dtype=int, default=None
259259
Array of indices used for testing. If ``None``, the complement of the
260-
``train_idx`` is used. If ``test_size`` is also None, 2-fold split is taken.
260+
``train_idx`` is used. If ``test_size`` is also ``None``, 2-fold split is taken.
261261
scaler : object implementing fit/transform, default=``StandardFlexibleScaler``
262262
Scales X and Y before computing the reconstruction measure. The default value
263263
scales the features such that the reconstruction measure on the training set is
@@ -333,11 +333,11 @@ def pointwise_local_reconstruction_error(
333333
Number of neighbour points used to compute the local reconstruction weight for
334334
each sample/point.
335335
train_idx : numpy.ndarray, dtype=int, default=None
336-
Array of indices used for training. If None, the complement of the ``test_idx``
337-
is used. If ``train_size`` is also ``None``, 2-fold split is taken.
336+
Array of indices used for training. If ``None``, the complement of the
337+
``test_idx`` is used. If ``train_size`` is also ``None``, 2-fold split is taken.
338338
test_idx : numpy.ndarray, dtype=int, default=None
339339
Array of indices used for testing. If ``None``, the complement of the
340-
``train_idx`` is used. If ``test_size`` is also None, 2-fold split is taken.
340+
``train_idx`` is used. If ``test_size`` is also ``None``, 2-fold split is taken.
341341
scaler : object implementing fit/transform, default=``StandardFlexibleScaler``
342342
Scales X and Y before computing the reconstruction measure. The default value
343343
scales the features such that the reconstruction measure on the training set is
@@ -444,11 +444,11 @@ def local_reconstruction_error(
444444
Number of neighbour points used to compute the local reconstruction weight for
445445
each sample/point.
446446
train_idx : numpy.ndarray, dtype=int, default=None
447-
Array of indices used for training. If None, the complement of the ``test_idx``
448-
is used. If ``train_size`` is also ``None``, 2-fold split is taken.
447+
Array of indices used for training. If ``None``, the complement of the
448+
``test_idx`` is used. If ``train_size`` is also ``None``, 2-fold split is taken.
449449
test_idx : numpy.ndarray, dtype=int, default=None
450-
Array of indices used for testing. If None, the complement of the ``train_idx``
451-
is used. If ``test_size`` is also None, 2-fold split is taken.
450+
Array of indices used for testing. If ``None``, the complement of the
451+
``train_idx`` is used. If ``test_size`` is also ``None``, 2-fold split is taken.
452452
scaler : object implementing fit/transform, default=``StandardFlexibleScaler``
453453
Scales X and Y before computing the reconstruction measure. The default value
454454
scales the features such that the reconstruction measure on the training set is

0 commit comments

Comments
 (0)