search

tidymodels / dials

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

Allowed parameter documentation is ... sparse #50

Open alexpghayes opened 5 years ago

alexpghayes commented 5 years ago

I had a really hard time figuring out what acceptable values are for parameters. Often times the documentation is unclear with regards to:

Beyond allowed values, some heuristics on what reasonable values are would also be valuable.

Occasionally categorical values aren't listed out either. Consider prune_method in mars, which only refers the user to earth::earth() without cross-linking the documentation.

On the whole, I strongly recommend a major update to the parameter documentation to add additional detail.

topepo commented 5 years ago

The current dev docs have more details