search

tidymodels / dials

Tools for creating tuning parameter values
https://dials.tidymodels.org/
Other
113 stars 27 forks source link

mismatch in `mtry` documentation #232

Closed simonpcouch closed 2 years ago

simonpcouch commented 2 years ago

dials currently documents mtry as:

https://github.com/tidymodels/dials/blob/39ab8338ab553aa53cc8ca981f13177b03dc251c/R/param_mtry.R#L1-L4

parsnip currently documents mtry as:

https://github.com/tidymodels/parsnip/blob/083fd9a6ccf7d1bca80297875d1ca894a0c2b11c/R/boost_tree.R#L22-L24

This came up while figuring out the interface for https://github.com/tidymodels/bonsai/issues/12. Some additional notes on possible interface there—if that interpretation seems sound, would the best route here would be to PR here adding "or proportion" to dials' documentation as well as moving the mtry_prop param here from rules?

EDIT: unsure about the above suggestion now—will bring this up in team meeting.

simonpcouch commented 2 years ago

Closing in favor of #233's interpretation.

github-actions[bot] commented 2 years ago

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.