LightGBM icon indicating copy to clipboard operation
LightGBM copied to clipboard

[python-package] [docs] Update key format of eval_hist in docstring example

Open Alnusjaponica opened this issue 2 years ago • 3 comments

Although the key format of eval_hist, which is return value of lightgbm.cv, is changed by https://github.com/microsoft/LightGBM/pull/2089, the document is not properly updated. This PR updates docstrings of lightgbm.cv.

Alnusjaponica avatar Jul 14 '23 22:07 Alnusjaponica

@jameslamb Thanks for the comment. I updated the name as you suggested. I also updated the description to make it more detailed. Please let me know if it is not necessary.

Alnusjaponica avatar Jul 14 '23 23:07 Alnusjaponica

Since eval_train_metric is not propagated to _agg_cv_result, it seems eval_results keys always have prefix "valid " or "train ". I'll confirm if it is true and update this PR.

Alnusjaponica avatar Jul 15 '23 00:07 Alnusjaponica

Hi, I updated the PR but cuda 11.7.1 wheel (linux, gcc, Python 3.11) seems to have failed unexpectedly. Could you re-run the CI?

Alnusjaponica avatar Jul 15 '23 09:07 Alnusjaponica

Isn't this prefix a breaking change? I just ran into it going from 3.3.4 to 4.1.0. Where could I find that in the release notes as such?

neverfox avatar Sep 14 '23 18:09 neverfox

@neverfox please open a new issue referencing this, and we. can discuss there. Let's not continue this discussion in the comments of an already-closed PR please.

jameslamb avatar Sep 14 '23 19:09 jameslamb

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.

github-actions[bot] avatar Dec 20 '23 00:12 github-actions[bot]