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] Add details on improving training speed #3628

Merged
merged 10 commits into from Dec 11, 2020
Merged

Conversation

jameslamb
Copy link
Collaborator

This PR proposes a large update to the documentation on tuning hyperparameters (https://lightgbm.readthedocs.io/en/latest/Parameters-Tuning.html). Today, that section contains simple suggestions like "use small max_depth". In this PR, I'm proposing adding some context to each recommendation so users can understand more of the intuition for how these parameters affect training or dataset construction. I think these descriptions can also help users to better understand how LightGBM works generally.

image

Notes for Reviewers

  • I didn't want this PR to get too big so I just covered the section For Faster Speed. If reviewers like this contribution, I'd be happy to add similar contributions like it in future PRs for For Better Accuracy and Deal with Overfitting.
  • @StrikerRUS I pushed this as a LightGBM doc so we can test readthedocs builds. Can you please enable builds for this branch?
  • Similar to [python] more detailed docs for trees_to_dataframe(), create_tree_digraph(), plot_tree() #3618 , I thought about this from reading Stack Overflow answers on the [lightgbm]. I might have a few more PRs in the coming weeks with more documentation change proposals like this.


Decrease ``feature_fraction`` to reduce training time.

Decrease ``max_cat_threshold``
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I based this paragraph on the explanations in #2261, #2411, and #2919

@StrikerRUS
Copy link
Collaborator

Can you please enable builds for this branch?

Done!

@btrotta
Copy link
Collaborator

btrotta commented Dec 8, 2020

@jameslamb This is great! I think it will make LightGBM a lot more accessible for people new to tree-boosting algorithms. I left a few small suggestions.

docs/Parameters-Tuning.rst Outdated Show resolved Hide resolved
docs/Parameters-Tuning.rst Show resolved Hide resolved
docs/Parameters-Tuning.rst Outdated Show resolved Hide resolved
@StrikerRUS
Copy link
Collaborator

@jameslamb Unfortunately, you couldn't modify Parameters.rst directly. You should include your fixes in config.h and then run helpers/parameter_generator.py script. Refer to the comment in Parameters.rst:

.. List of parameters is auto generated by LightGBM\helpers\parameter_generator.py from LightGBM\include\LightGBM\config.h file.

Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome addition! It greatly contributes to #2617, I believe. Just some minor typos below:

docs/Parameters-Tuning.rst Outdated Show resolved Hide resolved
docs/Parameters-Tuning.rst Outdated Show resolved Hide resolved
docs/Parameters-Tuning.rst Outdated Show resolved Hide resolved
docs/Parameters-Tuning.rst Outdated Show resolved Hide resolved
docs/Parameters.rst Outdated Show resolved Hide resolved
docs/Parameters.rst Outdated Show resolved Hide resolved
docs/Parameters.rst Outdated Show resolved Hide resolved
docs/Parameters.rst Outdated Show resolved Hide resolved
@jameslamb
Copy link
Collaborator Author

@jameslamb Unfortunately, you couldn't modify Parameters.rst directly. You should include your fixes in config.h and then run helpers/parameter_generator.py script. Refer to the comment in Parameters.rst:

.. List of parameters is auto generated by LightGBM\helpers\parameter_generator.py from LightGBM\include\LightGBM\config.h file.

ohhhh sorry I forgot this

@StrikerRUS StrikerRUS merged commit b69364e into master Dec 11, 2020
@StrikerRUS StrikerRUS deleted the docs/parameters branch December 11, 2020 19:16
@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

3 participants