Skip to content

Commit

Permalink
docs: improve tutorial regarding default values (#298)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebffischer authored Oct 16, 2023
1 parent d592f43 commit 3e43a28
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions vignettes/extending.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ These are:

* **tags** that organize the parameters, e.g. whether they are used during training or prediction.
* **default values** which give information about the value that is used by the upstream function when no value is set.
Note that this is not necessarily the default of the function signature but what is used internally: e.g. the default of parameter `a` for a function is `NULL`, but internally the value for `a` is set to `1` it is left as `NULL` by the caller.
* **initial values** are the initial `$values` of the parameter set that are set during construction.
* **custom checks** which allow to specify custom constraints for untyped parameters (`ParamUty`).

Expand Down

0 comments on commit 3e43a28

Please sign in to comment.