Skip to content

Commit

Permalink
docs: elapsed time does not include time for training the fallback
Browse files Browse the repository at this point in the history
  • Loading branch information
be-marc committed Nov 3, 2024
1 parent 50dd184 commit 5d9441f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions R/MeasureElapsedTime.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@
#'
#' @description
#' Measures the elapsed time during train ("time_train"), predict ("time_predict"), or both ("time_both").
#' Aggregation of elapsed time defaults to mean but can be configured via the field `aggregator` of the
#' [Measure].
#' Aggregation of elapsed time defaults to mean but can be configured via the field `aggregator` of the [Measure].
#'
#' When predictions for multiple predict sets were made during [resample()] or [benchmark()],
#' the predict time shows the cumulative duration of all predictions.
#' When predictions for multiple predict sets were made during [resample()] or [benchmark()], the predict time shows the cumulative duration of all predictions.
#' If `learner$predict()` is called manually, the last predict time gets overwritten.
#' The elapsed time accounts only for the training duration of the primary learner, excluding the time required for training the fallback learner.
#'
#' @template param_id
#' @templateVar id time_train
Expand Down
7 changes: 3 additions & 4 deletions man/mlr_measures_elapsed_time.Rd

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

0 comments on commit 5d9441f

Please sign in to comment.