search

tidymodels / dials

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

Uneven documentation of parameters #161

Open EmilHvitfeldt opened 3 years ago

EmilHvitfeldt commented 3 years ago

There is not a lot of documentation for the parameter functions. This is understandable since there isn't a lot to say many times. However, there are still some discrepancies. Here are some documentations that are handled differently

https://dials.tidymodels.org/reference/Laplace.html

https://dials.tidymodels.org/reference/all_neighbors.html

https://dials.tidymodels.org/reference/c5_parameters.html

I would think that the minimum standard should be

As a plus, it would be nice to have details concerning what they do like Laplace()

This parameter is often used to correct for zero-count data in tables or proportions.

But it can also be nice to list some of the places where the parameter is used. Although this might be hard due to dependency issues to make work with linking.