Skip to content

Commit 5172185

Browse files
Apply suggestions from code review
Co-authored-by: Philip Loche <[email protected]>
1 parent 7db6354 commit 5172185

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/skmatter/metrics/_reconstruction_measures.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ def pointwise_global_reconstruction_error(
4444
X use input shape (samples, features). For sample reconstruction of Y using X
4545
use input shape (features, samples).
4646
train_idx : numpy.ndarray, dtype=int, default=None
47-
Array of indices used for training. If None, the complement of the ``test_idx``
47+
Array of indices used for training. If ``None``, the complement of the ``test_idx``
4848
is used. If ``train_size`` is also None, 2-fold split is taken.
4949
test_idx : numpy.ndarray, dtype=int, default=None
50-
Array of indices used for testing. If None, the complement of the ``train_idx``
51-
is used. If ``test_size`` is also None, 2-fold split is taken.
50+
Array of indices used for testing. If ``None``, the complement of the ``train_idx``
51+
is used. If ``test_size`` is also ``None``, 2-fold split is taken.
5252
scaler : object implementing fit/transform, default=``StandardFlexibleScaler``
5353
Scales X and Y before computing the reconstruction measure. The default value
5454
scales the features such that the reconstruction measure on the training set is
@@ -111,7 +111,7 @@ def global_reconstruction_error(
111111
use input shape (features, samples).
112112
train_idx : numpy.ndarray, dtype=int, default=None
113113
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.
114+
is used. If ``train_size`` is also ``None``, 2-fold split is taken.
115115
test_idx : numpy.ndarray, dtype=int, default=None
116116
Array of indices used for testing. If None, the complement of the ``train_idx``
117117
is used. If ``test_size`` is also None, 2-fold split is taken.
@@ -253,10 +253,10 @@ def global_reconstruction_distortion(
253253
For feature reconstruction of Y using X use input shape (samples, features).
254254
For sample reconstruction of Y using X use input shape (features, samples).
255255
train_idx : numpy.ndarray, dtype=int, default=None
256-
Array of indices used for training. If None, the complement of the ``test_idx``
256+
Array of indices used for training. If ``None``, the complement of the ``test_idx``
257257
is used. If ``train_size`` is also None, 2-fold split is taken.
258258
test_idx : numpy.ndarray, dtype=int, default=None
259-
Array of indices used for testing. If None, the complement of the ``train_idx``
259+
Array of indices used for testing. If ``None``, the complement of the ``train_idx``
260260
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
@@ -334,9 +334,9 @@ def pointwise_local_reconstruction_error(
334334
each sample/point.
335335
train_idx : numpy.ndarray, dtype=int, default=None
336336
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.
337+
is used. If ``train_size`` is also ``None``, 2-fold split is taken.
338338
test_idx : numpy.ndarray, dtype=int, default=None
339-
Array of indices used for testing. If None, the complement of the ``train_idx``
339+
Array of indices used for testing. If ``None``, the complement of the ``train_idx``
340340
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
@@ -445,7 +445,7 @@ def local_reconstruction_error(
445445
each sample/point.
446446
train_idx : numpy.ndarray, dtype=int, default=None
447447
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.
448+
is used. If ``train_size`` is also ``None``, 2-fold split is taken.
449449
test_idx : numpy.ndarray, dtype=int, default=None
450450
Array of indices used for testing. If None, the complement of the ``train_idx``
451451
is used. If ``test_size`` is also None, 2-fold split is taken.

0 commit comments

Comments
 (0)