[python-package] make Booster and Dataset 'handle' attributes private (fixes #5313) #5947
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jameslamb
changed the title
jameslamb
requested review from
StrikerRUS,
shiyu1994 and
jmoralez
as code owners
guolinke
approved these changes
Jun 29, 2023
|
This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #5313.
Removes
handleattribute from the public API in the Python package, with the following changes:Booster.handle -> Booster._handleDataset.handle -> Dataset._handle_InnerPredictor.handle -> _InnerPredictor._handleWhy?
Making this implementation detail private allows changing it in the future without breaking user code.
@StrikerRUS originally recommended this, and I agree: #5313 (comment)
What about the R package?
Handles are already private there.
LightGBM/R-package/R/lgb.Booster.R
Line 107 in 9edea60
LightGBM/R-package/R/lgb.Dataset.R
Line 285 in 9edea60
How impactful will this be?
I don't know for sure what uses cases are out there where people are relying on the
handleattribute being public in the Python package. But I did a quick check of popular open source projects relying onlightgbm(https://www.wheelodex.org/projects/lightgbm/rdepends/) and didn't find any uses there:autogluon.tabular(search)lightgbm_ray(search)mlflow(search)mlforecast(search)optuna(search)pycaret(search)shap(search)