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 lightgbm_ray to docs #4584

Merged
merged 9 commits into from
Sep 9, 2021
Merged

[docs] add lightgbm_ray to docs #4584

merged 9 commits into from
Sep 9, 2021

Conversation

jameslamb
Copy link
Collaborator

I recently saw this blog post, "Introducing Distributed LightGBM Training with Ray".

ray is an open-source, Python-based framework for distributed computing. It's similar to Dask in a lot of ways, but was originally designed for reinforcement learning use cases (before growing into this general-purpose framework).

https://github.com/ray-project/lightgbm_ray is now officially a part of the Ray project, so I think it should be added to the "Distributed Learning Guide" here.

Notes for Reviewers

Tagging the lightgbm_ray contributors, @Yard1 and @richardliaw. Please let us know if you see any issues here (for example, I wasn't sure whether to use the name lightgbm_ray or LightGBM-Ray, since both are used in https://github.com/ray-project/lightgbm_ray).

Copy link

@richardliaw richardliaw left a comment

Choose a reason for hiding this comment

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

awesome! Would you be willing to take contributions to the docs about how to use LightGBM-Ray?

@jameslamb
Copy link
Collaborator Author

Would you be willing to take contributions to the docs about how to use LightGBM-Ray?

I'd prefer not to have documentation here that has to be kept up to date with LightGBM-Ray. For example, I wouldn't support having code snippets and advice at the level of depth we provide for the Dask interface (https://lightgbm.readthedocs.io/en/latest/Parallel-Learning-Guide.html#dask).

However, we'd welcome an additional link or two to tutorials. Similar to how we handle SynapseML (formerly mmlspark)

https://github.com/microsoft/LightGBM/blame/dc09d1b41f95f413a4dcb648478fdebf862c49ea/docs/Parallel-Learning-Guide.rst#L52

https://github.com/microsoft/LightGBM/blame/dc09d1b41f95f413a4dcb648478fdebf862c49ea/docs/Parallel-Learning-Guide.rst#L458

and kubeflow

https://github.com/microsoft/LightGBM/blame/dc09d1b41f95f413a4dcb648478fdebf862c49ea/docs/Parallel-Learning-Guide.rst#L350-L352

https://github.com/microsoft/LightGBM/blame/dc09d1b41f95f413a4dcb648478fdebf862c49ea/docs/Parallel-Learning-Guide.rst#L474-L480

@Yard1
Copy link
Contributor

Yard1 commented Sep 3, 2021

We can perhaps link to our docs then? https://docs.ray.io/en/latest/lightgbm-ray.html

Thanks for the PR!

@jameslamb
Copy link
Collaborator Author

We can perhaps link to our docs then? https://docs.ray.io/en/latest/lightgbm-ray.html

oh sure, thanks for that! I'll add that right now.

While I'm looking there...did you run into some issues doing distributed learning-to-rank training? Noticed that there isn't a RayLGBMRanker at https://docs.ray.io/en/latest/lightgbm-ray.html#scikit-learn-api.

If you ran into any problems we'd welcome issue reports at https://github.com/microsoft/LightGBM/issues.

@Yard1
Copy link
Contributor

Yard1 commented Sep 3, 2021

We just hadn't gotten around to adding ranking support just yet - it's on our todo list. Will definitely let you folks know if we run into any issues!

README.md Outdated Show resolved Hide resolved
docs/Parallel-Learning-Guide.rst Outdated Show resolved Hide resolved
docs/Parallel-Learning-Guide.rst Outdated Show resolved Hide resolved
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.

LGTM, very nice addition to our docs!

@StrikerRUS StrikerRUS merged commit fa1d06f into master Sep 9, 2021
@StrikerRUS StrikerRUS deleted the docs/lightgbm-ray branch September 9, 2021 16:10
@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 23, 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.

4 participants