Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Documentation of Handler's "replace_with" parameter is misguiding #457

@antoniovs1029

Description

@antoniovs1029

The documentation for the Handler class (link) mentions the following for the "replace_with" parameter:

replace_with

The method to use to replace NaN values. The following choices are available.
Def: Replace with default value of that type, usually 0. If no
replace method is specified, this is the default strategy.
Mean: Replace NaN values with the mean of the values in that column.
Min: Replace with minimum value in the column.
Max: Replace with maximum value in the column.

This is misguiding, since the actual options that it accepts are the following:

values=[
'DefaultValue',
'Mean',
'Minimum',
'Maximum'])

If I try to use replace_with='Max' then I get the following cryptic error message:
parameter passed not in values.

Since it's actually expected to use replace_with='Maximum', although the documentation doesn't say it explicitly, and the error message doesn't say which parameter of what component is not accepted.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1Needs to be fixed soon.documentationDocumentation for components

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions