-
Notifications
You must be signed in to change notification settings - Fork 532
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
[DOC] GPU Enabled Random Forest Regressor documentation is wrong. #4623
Comments
@vinaydes @venkywonka could I ask one of you to check this out? |
Thank you @LaneMatthewJ for the issue! Apologies for the delay and the improper documentation, have fixed it in the above linked PR 😄 |
Awesome! Thank you so much! |
This small PR : * Rectifies/clarifies the wrong parameter description for `max_depth` parameter in `RandomForestRegressor` and `RandomForestClassifier` in RF and dask-RF. * Corrects a syntax error in dask-rf docs * Corrects the `max_depth` check in RF-python layer resolves #4623 Authors: - Venkat (https://github.com/venkywonka) Approvers: - Rory Mitchell (https://github.com/RAMitchell) - Dante Gama Dessavre (https://github.com/dantegd) URL: #4666
Hey @venkywonka! Out of curiosity does the documentation on the site only get built during the pushing of a new version? (also - thank you again!) |
Hi, so sorry for the delay in response! If I understand correctly, every merge to the main branch is updated in the nightly docs but the URL you posted above is that of the stable docs that usually corresponds to one version previous to the default branch (ie, 22.06 as current default branch is 22.08). |
This small PR : * Rectifies/clarifies the wrong parameter description for `max_depth` parameter in `RandomForestRegressor` and `RandomForestClassifier` in RF and dask-RF. * Corrects a syntax error in dask-rf docs * Corrects the `max_depth` check in RF-python layer resolves rapidsai#4623 Authors: - Venkat (https://github.com/venkywonka) Approvers: - Rory Mitchell (https://github.com/RAMitchell) - Dante Gama Dessavre (https://github.com/dantegd) URL: rapidsai#4666
Report incorrect documentation
Hello!
In working with cuML Random Forest Regressor (both single and multi-gpu) I found some errors in the documentation (for the current stable build*) and have noted them below!
Location of incorrect documentation
Problem 1: Run Time Error with
max_depth = -1
:In the Dask Random Forest Regressor documentation there exists a subsection for
max_detph
suggesting that the regressor can have an unlimited max depth with-1
as a parameter.Problem 2: Sytax Error with assignment in dictionary:
Under
fit
of bothRandom Forest Classifier
andRandom Forest Regressor
there exists a syntax error:Describe the problems or issues found in the documentation
Problem 1
When attempting to use
-1
as a parameter for max depthThe following error is returned:
Problem 2:
Syntax errors won't run.
Steps taken to verify documentation is incorrect
Problem 1:
Run Time Error occurs.
Problem 2:
Syntax Error will not run
*Suggested fix for documentation
Problem 1:
Update documentation to denote that there exists no unlimited depth option
Problem 2:
Update documentation to have no syntax errors.
Report needed documentation
Report needed documentation
I think the documentation ought to match the implementation.
Describe the documentation you'd like
Updated documentation that matches the implementation
Steps taken to search for needed documentation
N/A
The text was updated successfully, but these errors were encountered: