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

Documentation issue: rand_forest function help falsely lists h2o as an engine option #1077

Closed
birbritto opened this issue Feb 28, 2024 · 2 comments

Comments

@birbritto
Copy link

when calling the help on rand_forest:

?rand_forest

It lists h2o in the engine-specific pages for the model, implying that that's an option for an engine. However, using:

show_engines('rand_forest') gives:

# A tibble: 6 × 2
  engine       mode          
  <chr>        <chr>         
1 ranger       classification
2 ranger       regression    
3 randomForest classification
4 randomForest regression    
5 spark        classification
6 spark        regression 

and trying to use h2o gives this error:

rf_fit <- rand_forest(trees = 100, mode = "unknown") %>%
+   set_engine("h2o")  %>% fit ( something ~ var1 + var2 etc, data = training_data)
Error in `set_engine()`:
! Engine 'h2o' is not supported for `rand_forest()`. See `show_engines('rand_forest')`.

Requesting an update to the documentation if that makes sense. Thank you

@simonpcouch
Copy link
Contributor

Thanks for the issue!

The rand_forest docs note that h2o requires a parsnip extension package with the "2" superscript. From ?rand_forest

Screenshot 2024-02-28 at 10 15 55 AM

Clicking the h2o hyperlink from the docs will show that you need to load the agua extension package with library(agua) to use this engine. :)

I will keep this issue open in case we think we might be able to provide better errors or docs to make this visible to folks.

@topepo topepo closed this as completed Jul 15, 2024
Copy link

This issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.

@github-actions github-actions bot locked and limited conversation to collaborators Jul 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants