User guide equal width discretiser - #747
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
|
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 |
…iser reworded user guides
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`. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
* 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>
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 .