Skip to content

Commit 6069874

Browse files
skeller88adrinjalali
authored andcommitted
DOC Add explanation of why iterative imputer is experimental (scikit-learn#17115)
1 parent 3469a47 commit 6069874

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

doc/modules/impute.rst

+9-7
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,12 @@ imputation round are returned.
105105

106106
.. note::
107107

108-
This estimator is still **experimental** for now: the predictions
109-
and the API might change without any deprecation cycle. To use it,
110-
you need to explicitly import ``enable_iterative_imputer``.
108+
This estimator is still **experimental** for now: default parameters or
109+
details of behaviour might change without any deprecation cycle. Resolving
110+
the following issues would help stabilize :class:`IterativeImputer`:
111+
convergence criteria (:issue:`14338`), default estimators (:issue:`13286`),
112+
and use of random state (:issue:`15611`). To use it, you need to explicitly
113+
import ``enable_iterative_imputer``.
111114

112115
::
113116

@@ -216,9 +219,9 @@ neighbors of samples with missing values::
216219
[5.5, 6. , 5. ],
217220
[8. , 8. , 7. ]])
218221

219-
.. [OL2001] Olga Troyanskaya, Michael Cantor, Gavin Sherlock, Pat Brown,
220-
Trevor Hastie, Robert Tibshirani, David Botstein and Russ B. Altman,
221-
Missing value estimation methods for DNA microarrays, BIOINFORMATICS
222+
.. [OL2001] Olga Troyanskaya, Michael Cantor, Gavin Sherlock, Pat Brown,
223+
Trevor Hastie, Robert Tibshirani, David Botstein and Russ B. Altman,
224+
Missing value estimation methods for DNA microarrays, BIOINFORMATICS
222225
Vol. 17 no. 6, 2001 Pages 520-525.
223226
224227
.. _missing_indicator:
@@ -310,4 +313,3 @@ wrap this in a :class:`Pipeline` with a classifier (e.g., a
310313
>>> results = clf.predict(X_test)
311314
>>> results.shape
312315
(100,)
313-

0 commit comments

Comments
 (0)