Skip to content

Commit

Permalink
docs standardization
Browse files Browse the repository at this point in the history
  • Loading branch information
advieser committed Feb 6, 2025
1 parent 8410945 commit df7c996
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
3 changes: 2 additions & 1 deletion R/PipeOpEncodeImpact.R
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
#' this feature level on each *outcome level*.
#'
#' @section Parameters:
#' The parameters are the parameters inherited from [`PipeOpTaskPreproc`], as well as:
#' * `smoothing` :: `numeric(1)` \cr
#' A finite positive value used for smoothing. Mostly relevant for [classification Tasks][mlr3::TaskClassif] if
#' a factor does not coincide with a target factor level (and would otherwise give an infinite logit value).
Expand All @@ -54,7 +55,7 @@
#' Uses Laplace smoothing, mostly to avoid infinite values for [classification Task][mlr3::TaskClassif].
#'
#' @section Methods:
#' Only methods inherited [`PipeOpTaskPreproc`]/[`PipeOp`].
#' Only methods inherited [`PipeOpTaskPreprocSimple`][`PipeOpTaskPreproc`]/[`PipeOp`].
#'
#' @examples
#' library("mlr3")
Expand Down
6 changes: 3 additions & 3 deletions R/PipeOpEncodeLmer.R
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@
#' List of coefficients learned via `glmer`
#'
#' @section Parameters:
#' The parameters are the parameters inherited from [`PipeOpTaskPreproc`], as well as:
#' * `fast_optim` :: `logical(1)` \cr
#' If `fast_optim` is `TRUE` (default), a faster (up to 50 percent) optimizer from the `nloptr` package is used when
#' fitting the lmer models. This uses additional stopping criteria which can give suboptimal results.
#' Initialized to `TRUE`.
#' If "fast_optim" is `TRUE` (default), a faster (up to 50 percent)
#' optimizer from the nloptr package is used when fitting the lmer models.
#' This uses additional stopping criteria which can give suboptimal results.
#'
#' @section Internals:
#' Uses the [`lme4::glmer`]. This is relatively inefficient for features with a large number of levels.
Expand Down
3 changes: 2 additions & 1 deletion man/mlr_pipeops_encodeimpact.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/mlr_pipeops_encodelmer.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit df7c996

Please sign in to comment.