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 on 'tunable' in Param and LearnerParam is off #182

Open
mb706 opened this issue Jun 18, 2017 · 0 comments
Open

Documentation on 'tunable' in Param and LearnerParam is off #182

mb706 opened this issue Jun 18, 2017 · 0 comments

Comments

@mb706
Copy link
Collaborator

mb706 commented Jun 18, 2017

?Param and ?LearnerParam both mention

 tunable: [‘logical(1)’]
          Is this parameter tunable? Defining a parameter to be
          not-tunable allows to mark arguments like, e.g., “verbose” or
          other purely technical stuff, and allows them to be excluded
          from later automatic optimization procedures that would try
          to consider all available parameters. Default is ‘TRUE’
          (except for ‘untyped’, ‘function’, ‘character’ and
          ‘characterVector’) which means it is tunable.

The last two lines are misleading for character and characterVector, which do not even have a tunable parameter, and apparently wrong for untyped and funtion, which both have tunable = TRUE in their function head.

> makeUntypedParam
function (id, default, requires = NULL, tunable = TRUE, special.vals = list()) 
[etc]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant