Skip to content

Docstring not enough informative for Pipeline class #444

Closed
@IronFarm

Description

@IronFarm

Description

The docstrings for multiple methods in the Pipeline class state that the methods "Apply transformers/samplers...". However, most of the methods ignore the samplers e.g. the predict method:

"""Apply transformers/samplers to the data, and predict with the final
estimator
vs.
if hasattr(transform, "fit_sample"):
pass

The behaviour appears to be correct (sampling should only be applied when fitting) but the docstrings are misleading.

Affected Methods

  • predict
  • predict_proba
  • decision_function
  • predict_log_proba
  • score

Metadata

Metadata

Assignees

No one assigned

    Labels

    For: DocumentationIndicates a need for improvements or additions to documentationStatus: Help WantedIndicates that a maintainer wants help on an issue or pull requestgood first issueIndicates a good issue for first-time contributors

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions