Skip to content

Commit

Permalink
DOC Add explanation of why iterative imputer is experimental (#17115)
Browse files Browse the repository at this point in the history
  • Loading branch information
skeller88 authored and adrinjalali committed May 19, 2020
1 parent 6088842 commit 25e6fd1
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions doc/modules/impute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,12 @@ imputation round are returned.

.. note::

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

::

Expand Down Expand Up @@ -216,9 +219,9 @@ neighbors of samples with missing values::
[5.5, 6. , 5. ],
[8. , 8. , 7. ]])

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

0 comments on commit 25e6fd1

Please sign in to comment.