Skip to content
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

[docs] update documentation with AUC-mu, average precision #3627

Merged
merged 2 commits into from
Dec 4, 2020

Conversation

jameslamb
Copy link
Collaborator

I was reading https://lightgbm.readthedocs.io/en/latest/Features.html today and realized that a list of metrics is maintained there. That list is missing some of the newer things that @btrotta has added (average precision, AUC-mu). This PR proposes adding them.

I'm also proposing something I think we should do more of...adding a label like new in v3.0.0. Since we only host one version of the documentation, based on master, I think these types of annotations are useful. This is a practice I really appreciate in the scikit-learn docs, for example.

For example, https://scikit-learn.org/stable/modules/generated/sklearn.compose.ColumnTransformer.html#sklearn-compose-columntransformer

image

@StrikerRUS
Copy link
Collaborator

StrikerRUS commented Dec 4, 2020

Good idea of adding version info!

For other items next time we can use a special Sphinx directive versionadded. (We cannot use it here because this directive is paragraph-level.)

@jameslamb
Copy link
Collaborator Author

Good idea of adding version info!

For other items next time we can use a special Sphinx directive versionadded. (We cannot use it here because this directive is paragraph-level.)

oh cool! I did not know about that!

@jameslamb jameslamb merged commit d83b973 into microsoft:master Dec 4, 2020
@jameslamb jameslamb deleted the docs/more-metrics branch December 4, 2020 17:30
@github-actions
Copy link

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 github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants