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

Document global options + improve option names #500

Open
avehtari opened this issue Apr 26, 2024 · 1 comment
Open

Document global options + improve option names #500

avehtari opened this issue Apr 26, 2024 · 1 comment
Labels
documentation Documentation issues. enhancement Enhancements of existing features, but also new feature requests.

Comments

@avehtari
Copy link
Collaborator

Some of the option names are ugly. As they are not yet publicly documented, I think we should change these

  • projpred.prll_cv -> projpred.parallel_cv

These are documented, but still would be better to change

  • projpred.warn_prj_drawwise -> projpred.warn_proj_drawwise
  • projpred.check_conv -> projpred.check_convergence
  • projpred.prll_prj_trigger -> projpred.parallel_proj_trigger

There are undocumented global options that should be documented

@fweber144
Copy link
Collaborator

Thanks. I'm open to renaming these options. Concerning projpred.prll_cv, I just want to add that it is (indirectly) documented because it appears in the default of argument parallel of cv_varsel.refmodel().

For the yet-undocumented global options that should be documented, I'm also open to documenting these. Just for the background: I did not document all global options because some referred to yet-experimental features for which implementation (including theoretical investigations, documentation, and tests) is not finished yet (see, e.g., global option projpred.glm_fitter) or they were added only for internal purposes (see, e.g., many of the projpred.warn_[...] options, like projpred.warn_additive_experimental, which were added only to deactivate the corresponding warning messages in the unit tests).

@fweber144 fweber144 added enhancement Enhancements of existing features, but also new feature requests. documentation Documentation issues. labels Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation issues. enhancement Enhancements of existing features, but also new feature requests.
Projects
None yet
Development

No branches or pull requests

2 participants