Skip to content

User guide equal width discretiser - #747

Merged
solegalli merged 8 commits into
feature-engine:mainfrom
cmcouto-silva:UserGuide_EqualWidthDiscretiser
Apr 26, 2024
Merged

User guide equal width discretiser#747
solegalli merged 8 commits into
feature-engine:mainfrom
cmcouto-silva:UserGuide_EqualWidthDiscretiser

Conversation

@cmcouto-silva

Copy link
Copy Markdown
Contributor

I've updated the EqualWidthDiscretiser user guide page with more info and structured topics.
The content grade is A- on clearscope: https://www.clearscope.io/coursemaker/reports/768deaa72128c3fc/editor

The existing image was updated to ensure reproducibility.
All tests passed with sphinx-build -b html docs build .

@codecov

codecov Bot commented Apr 25, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.18%. Comparing base (f5bbc90) to head (9b7938f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #747   +/-   ##
=======================================
  Coverage   98.18%   98.18%           
=======================================
  Files         105      105           
  Lines        4074     4074           
  Branches      795      795           
=======================================
  Hits         4000     4000           
  Misses         29       29           
  Partials       45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment thread docs/user_guide/discretisation/EqualWidthDiscretiser.rst Outdated
@solegalli

Copy link
Copy Markdown
Collaborator

Hey @cmcouto-silva

Thank you so much for this amazing contribution! Made a PR to you repo: cmcouto-silva#1

If you merge over there, then we are good to merge here and deploy!

Cheers

Remove numpy.nan statement and update text from discretiser to discretizer.
variables.

**Optimal number of intervals:** With :class:`EqualWidthDiscretiser()`, the user defines the number of bins. Smaller intervals
may be required if the variable is highly skewed or not continuous. Otherwise, the transformer will introduce `numpy.nan`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cmcouto-silva sorry for the misunderstanding, here I meant removing only the part that says "Otherwise, the transformer will introduce numpy.nan.", not the entire sentence. Could you put the rest back?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, @solegalli!

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing! Thank you!

I'll deploy now, and make sure to add you to the contributors for our next release. The new docs will be live from now. And I'll be back in touch on Monday :)

Adding back the optimal number of intervals, without the numpy.nan statement.
@solegalli
solegalli merged commit a718b17 into feature-engine:main Apr 26, 2024
@cmcouto-silva
cmcouto-silva deleted the UserGuide_EqualWidthDiscretiser branch April 26, 2024 12:53
solegalli added a commit that referenced this pull request May 6, 2024
* update EqualFrequencyDiscretiser user guide text and images

* update EqualFrequencyDiscretiser user guide text and images

* update EqualWidthDiscretiser user guide text and image

* reworded equal width copy

* re worded equal frequency class

* Update EqualWidthDiscretiser.rst

Remove numpy.nan statement and update text from discretiser to discretizer.

* Update EqualWidthDiscretiser.rst

Adding back the optimal number of intervals, without the numpy.nan statement.

---------

Co-authored-by: Soledad Galli <solegalli@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants