[MRG] Add explanation of why iterative imputer is experimental #17115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reference current issues needed to be resolved before class can potentially be stabilized.
skeller88
changed the title
TomDLT
approved these changes
May 5, 2020
jnothman
reviewed
May 5, 2020
doc/modules/impute.rst
Outdated
| 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, | ||
| specifically convergence criteria (`issue 14338 <https://github.com/scikit-learn/scikit-learn/issues/14338>`_), |
There was a problem hiding this comment.
Suggested change
| specifically convergence criteria (`issue 14338 <https://github.com/scikit-learn/scikit-learn/issues/14338>`_), | |
| specifically convergence criteria (:issue:`14338`), |
You can use these shortcuts from the Sphinx-issues extension
thomasjpfan
reviewed
May 8, 2020
doc/modules/impute.rst
Outdated
Comment on lines
108
to
113
| This estimator is still **experimental** for now: default parameters or | ||
| details of behaviour might change without any deprecation cycle, | ||
| specifically 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``. |
There was a problem hiding this comment.
This can be broken up into two sentences:
This estimator is still experimental for now: default parameters or details of behavior might change without any deprecation cycle. Resolving the following issues would help stabilize :class:
IterativeImputer: ...
|
Thanks @skeller88 |
adrinjalali
pushed a commit
to adrinjalali/scikit-learn
that referenced
this pull request
May 18, 2020
adrinjalali
pushed a commit
that referenced
this pull request
May 19, 2020
viclafargue
pushed a commit
to viclafargue/scikit-learn
that referenced
this pull request
Jun 26, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #16638 by referencing current issues needed to be resolved before class can potentially be stabilized. That makes it clearer to potential users of this class what the current unknowns are, and makes it easier for potential contributors to help with these issues.