Skip to content

unclear documentation at RandomUndersampler and RandomOverSampler #517

Closed
@snowparrot

Description

@snowparrot

Hello, there are two minor issues I see in the docs of RandomUnderSampler and RandomOversampler.

  • There is the constraint that the float in sampling_strategy should be between 0 and 1. It should be documented explicitly.
  • . "Therefore, the ratio is expressed as \alpha_{us} = N_{rM} / N_{m} where N_{rM} and N_{m} are the number of samples in the majority class after resampling and the number of samples in the minority class, respectively."
    should be replaced by
    "Therefore, the ratio is expressed as \alpha_{us} = N_{rM} / N_{m} where N_{rM} is the number of samples in the majority class after resampling and N_{m} is the number of samples in the minority class after resampling , respectively."
    The new version puts the definition next to variable (clearity) and adds another "after resampling". Im a big fan of clear definition for math formulars. Also you might assume that the reader isnt a profane reader of English. Clear definition are easier to read.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions