imbalanced-learn icon indicating copy to clipboard operation
imbalanced-learn copied to clipboard

[DOC] InstanceHardnessThreshold docstring states non-existent functionality for the estimator argument

Open anryabrahamyan opened this issue 1 year ago • 2 comments

Describe the issue linked to the documentation

The InstanceHardnessThreshold class docstring states that a string can be passed as an argument for the estimator argument and lists the possible strings that can be passed. An error is raised when I pass these strings and the GitHub code does not have that functionality in it as well.

Suggest a potential alternative/fix

Remove passing a string as an argument for the estimator until this functionality is added because it is misleading for the users.

anryabrahamyan avatar Aug 04 '22 13:08 anryabrahamyan

Hi, I believe this was already raised in issue #889 and fixed in this PR:

https://github.com/scikit-learn-contrib/imbalanced-learn/pull/890

miguelfmc avatar Aug 08 '22 03:08 miguelfmc

The stable documentation for InstanceHardnessThreshold is pointing to 9f8830e.

This is resolved in the dev version: https://imbalanced-learn.org/dev/references/generated/imblearn.under_sampling.InstanceHardnessThreshold.html

This might be an issue with the sphinx build.

hayesall avatar Aug 09 '22 17:08 hayesall

We will be releasing and it will be up to date soonish.

glemaitre avatar Dec 03 '22 21:12 glemaitre