🐛 Add Warning for VahadaneExtractor Algorithm Instability
#871
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
shaneahmed
changed the title
shaneahmed
changed the title
VahadaneExtractor Algorithm Instability
mostafajahanifar
force-pushed
the
issue-vahadane-warn
branch
from
1733edc
to
86886d9
Compare
shaneahmed
reviewed
Oct 18, 2024
| @@ -259,6 +266,14 @@ def __init__( | |||
| regularizer: float = 0.1, | |||
| ) -> None: | |||
| """Initialize :class:`VahadaneExtractor`.""" | |||
| # Issue a warning about the algorithm's stability | |||
| logger.warning( | |||
There was a problem hiding this comment.
@mostafajahanifar Please can you add links to alternatives as discussed during the meeting?
shaneahmed
requested changes
Oct 18, 2024
There was a problem hiding this comment.
Thanks @mostafajahanifar. Please can you add links to alternative repos users can use. Also, please can you add test using pytest capture caplog.text to verify the warning is caught?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #871 +/- ##
========================================
Coverage 99.88% 99.88%
========================================
Files 69 69
Lines 8656 8658 +2
Branches 1147 1147
========================================
+ Hits 8646 8648 +2
Misses 4 4
Partials 6 6 ☔ View full report in Codecov by Sentry. |
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.
This PR adds a warning to the VahadaneExtractor class to inform users about the algorithm's instability due to changes in the dictionary learning algorithm in scikit-learn versions > 0.23.0 (see issue #382). The docstrings are updated accordingly to reflect this warning. No other functionality is altered.