Skip to content

Conversation

@flinder
Copy link
Contributor

@flinder flinder commented Jan 29, 2026

Summary: The API documentation was exposing internal implementation details (DEFAULT_HYPERPARAMS, UNSHRINK_LOGIT_EPSILON) that should not be part of the public API. Making these attributes private (prefixed with _) hides them from the generated Sphinx documentation.

Differential Revision: D91786473

@meta-codesync
Copy link

meta-codesync bot commented Jan 29, 2026

@flinder has exported this pull request. If you are a Meta employee, you can view the originating Diff in D91786473.

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jan 29, 2026
@codecov-commenter
Copy link

codecov-commenter commented Jan 29, 2026

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@c2b8319). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #193   +/-   ##
=======================================
  Coverage        ?   94.92%           
=======================================
  Files           ?        9           
  Lines           ?     1753           
  Branches        ?        0           
=======================================
  Hits            ?     1664           
  Misses          ?       89           
  Partials        ?        0           
Flag Coverage Δ
unittests 94.92% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Summary:
The API documentation was exposing internal implementation details (DEFAULT_HYPERPARAMS, UNSHRINK_LOGIT_EPSILON) that should not be part of the public API. Making these attributes private (prefixed with `_`) hides them from the generated Sphinx documentation.

For backward compatibility, deprecated aliases are provided via the existing `DeprecatedAttributesMixin` on MCBoost/RegressionMCBoost. These emit `DeprecationWarning` when accessed. Internal users using MCBoost can continue using the old names but will see deprecation warnings encouraging migration to the new private names.

Differential Revision: D91786473
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot. fb-exported meta-exported

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants