Skip to content

[DOC] update categorical encoders user guide#919

Merged
solegalli merged 24 commits into
mainfrom
catencuserguide
Jul 21, 2026
Merged

[DOC] update categorical encoders user guide#919
solegalli merged 24 commits into
mainfrom
catencuserguide

Conversation

@solegalli

Copy link
Copy Markdown
Collaborator

No description provided.

@codecov

codecov Bot commented Mar 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.27%. Comparing base (c89a3b0) to head (1a089b1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #919   +/-   ##
=======================================
  Coverage   98.27%   98.27%           
=======================================
  Files         116      116           
  Lines        4978     4978           
  Branches      795      795           
=======================================
  Hits         4892     4892           
  Misses         55       55           
  Partials       31       31           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.


.. math::
a_{subindex} = a_i cw
b_{bin_index} = Min + cw^{bin_index}

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Hi @glevv

I am updating the docs for various classes, and in doing so, I noticed that what we had as explanation for how the geometric discretiser works did not match the code output that was produced by the class. So evidently, the documentation is wrong, in the sense, that it does not explain what the class does.

Claude said that I need to update the formula like this to match the code base. Would you agree?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

He wrote the formula straight out of the code, it is fine. The original formula tried to convey the general idea of geometric progression, the new is closer to the specific implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

They are both fine IMO, but the Claude version is closer to the code


.. math::
a_{i+1} = a_i cw
b_i = Min + cw^i

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@glevv

Could you also check whether these changes make sense?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

awesome, thank you!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It is correct

Comment thread docs/user_guide/encoding/StringSimilarityEncoder.rst Outdated
@solegalli
solegalli merged commit 51ffb86 into main Jul 21, 2026
12 of 13 checks passed
@solegalli
solegalli deleted the catencuserguide branch July 21, 2026 04:45
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