[MRG] Deprecate lsh forest #9078
Merged
Conversation
This file contains hidden or 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
ogrisel
reviewed
Jun 9, 2017
sklearn/neighbors/approximate.py
Outdated
| @@ -217,6 +217,10 @@ def __init__(self, n_estimators=10, radius=1.0, n_candidates=50, | |||
| self.min_hash_match = min_hash_match | |||
| self.radius_cutoff_ratio = radius_cutoff_ratio | |||
|
|
|||
| warnings.warn("LSHForest has poor performance.") | |||
There was a problem hiding this comment.
Please remove that line. Or making an inline comment instead of an independent UserWarning.
There was a problem hiding this comment.
The original issue mentioned
LSHForest should be deprecated and scheduled for removal in 0.21. It should also warn about having bad performance
I could make the deprecation warning:
LSHForest has poor performance and has been deprecated in 0.19. It will be removed in version 0.21.
|
Remaining TODOs:
|
|
I removed the section on approximate neighbors entirely, but I'm having second thoughts about it. If we go ahead and remove it I'll mention in the relevant PRs (that allow ANN, I think PR #8999 does that) that what we removed can be used as a basis for new documentation. I would have liked to keep some paragraphs but it feels weird to have general considerations that don't relate to any scikit-learn class. |
amueller
reviewed
Jun 9, 2017
doc/whats_new.rst
Outdated
| @@ -427,6 +427,10 @@ API changes summary | |||
| :class:`cluster.bicluster.SpectralBiclustering` now accept ``y`` in fit. | |||
| :issue:`6126` by `Andreas Müller`_. | |||
|
|
|||
| - :class:`neighbors.approximate.LSHForest` has been deprecated and will be | |||
| removed in 0.21 due to poor performance. | |||
| :issue:`8996` by `Andreas Müller`_. | |||
There was a problem hiding this comment.
the by refers to the person coding, not the issue raiser
13c339a to
af9da5a
Compare
ogrisel
approved these changes
Jun 9, 2017
af9da5a to
bb584f9
Compare
|
Appveyor seems to have randomly failed but otherwise I think it's ready for merge. |
|
LGTM, thanks |
Sundrique
pushed a commit
to Sundrique/scikit-learn
that referenced
this pull request
Jun 14, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
dmohns
pushed a commit
to dmohns/scikit-learn
that referenced
this pull request
Aug 7, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
dmohns
pushed a commit
to dmohns/scikit-learn
that referenced
this pull request
Aug 7, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
NelleV
pushed a commit
to NelleV/scikit-learn
that referenced
this pull request
Aug 11, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
paulha
pushed a commit
to paulha/scikit-learn
that referenced
this pull request
Aug 19, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
AishwaryaRK
pushed a commit
to AishwaryaRK/scikit-learn
that referenced
this pull request
Aug 29, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
maskani-moh
pushed a commit
to maskani-moh/scikit-learn
that referenced
this pull request
Nov 15, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
jwjohnson314
pushed a commit
to jwjohnson314/scikit-learn
that referenced
this pull request
Dec 18, 2017
* Add deprecation message and test. * Adding performance warning and ignore_warnings in test * Add deprecation to whatsnew and remove LSHForest references from docs. Removing benchmark for lsh
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.
Reference Issue
Fixes #8996
What does this implement/fix? Explain your changes.
Add a deprecation (removed in 0.21) and performance warning for
LSHForest.Any other comments?
Since both are linked it would make sense I think. For now I issued 2 separate warnings.
@ignore_warningsdecorator which does not seem to be doing his job in nested function calls: I had to use inline calls toignore_warningseverywhere, which is not super nice.