-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ci] [docs] docs rendering failing with 'undefined label: 'metadata_routing' #5954
Comments
I see the following in the release notes (link)
I'm still reading through this to understand what it means and why it'd show up as a breaking change in the documentation generation. |
I think I see the problem. All of
LightGBM/python-package/lightgbm/sklearn.py Line 391 in 9f78cce
LightGBM/python-package/lightgbm/sklearn.py Line 1068 in 9f78cce
LightGBM/python-package/lightgbm/dask.py Line 1124 in 9f78cce
When we render this project's Prior to v1.3.0, LightGBM/python-package/lightgbm/sklearn.py Lines 583 to 584 in 9f78cce
LightGBM/python-package/lightgbm/sklearn.py Lines 601 to 602 in 9f78cce
As of v1.3.0, there's now a third public method, from sklearn.base import BaseEstimator
[x for x in dir(BaseEstimator) if not x.startswith("_")]
# ['get_metadata_routing', 'get_params', 'set_params'] Since that isn't overridden by from sklearn.base import BaseEstimator
BaseEstimator.get_metadata_routing.__doc__ shows:
See that It's a reference to this scikit-learn-only Ok, so what do we do? I'm going to do the following right now to unblock development in this repo:
And then after that, I'll do the following:
|
cc @trivialfis @hcho3, you might see the same thing the next time Hopefully this write-up can save you some time. |
Thank you for the detailed analysis @jameslamb ! I saw this PR: #5956 by @thomasjpfan . XGBoost is using |
From another repo that inherits |
Sure, glad it helped you! |
This issue 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. |
Description
The
check-docs
CI job is failing with this error that seems to be occurring while rendering the sphinx docs to HTML(build link)
Reproducible example
I see that in multiple CI builds here, including the latest on
master
(build link).I'm able to reproduce this locally in a Python 3.10 environment on macOS, with the following:
mamba install --yes \ breathe \ doxygen \ scikit-learn \ sphinx \ sphinx_rtd_theme \ 'scikit-learn>=1.3'
Additional Notes
When downgrading from
scikit-learn
1.3.0 to 1.2.2, this error goes away and the docs render correctly. I strongly suspect that it's related to changes in the most recent version ofscikit-learn
.The text was updated successfully, but these errors were encountered: