resample()This is the result container object returned by resample().
Note that all stored objects are accessed by reference. Do not modify any object without cloning it first.
as.data.table(rr, reassemble_learners = TRUE, convert_predictions = TRUE, predict_sets = "test")
ResampleResult -> data.table::data.table()
Returns a tabular view of the internal data.
c(...)
(ResampleResult, ...) -> BenchmarkResult
Combines multiple objects convertible to BenchmarkResult into a new BenchmarkResult.
data(ResultData)
Internal data storage object of type ResultData.
We discourage users to directly work with this field.
Use as.table.table(ResampleResult) instead.
view(character(1))
Subset of uhashes in the ResultData object to operate on.
This field is for internal optimizations, i.e. to avoid unnecessary cloning.
task_type(character(1))
Task type of objects in the ResampleResult, e.g. "classif" or "regr".
This is NA for empty ResampleResults.
uhash(character(1))
Unique hash for this object.
task(Task)
The task resample() operated on.
learner(Learner)
Learner prototype resample() operated on.
For a list of trained learners, see methods $learners().
resampling(Resampling) Instantiated Resampling object which stores the splits into training and test.
learners(list of Learner) List of trained learners, sorted by resampling iteration.
warnings(data.table::data.table())
A table with all warning messages.
Column names are "iteration" and "msg".
Note that there can be multiple rows per resampling iteration if multiple warnings have been recorded.
errors(data.table::data.table())
A table with all error messages.
Column names are "iteration" and "msg".
Note that there can be multiple rows per resampling iteration if multiple errors have been recorded.
new()Creates a new instance of this R6 class.
An alternative construction method is provided by as_resample_result().
ResampleResult$new(data = ResultData$new(), view = NULL)
data(ResultData | data.table())
An object of type ResultData, either extracted from another ResampleResult, another
BenchmarkResult, or manually constructed with as_result_data().
view(character())
Single uhash of the ResultData to operate on.
Used internally for optimizations.
format()Helper for print outputs.
ResampleResult$format()
print()Printer.
ResampleResult$print()
...(ignored).
help()Opens the corresponding help page referenced by field $man.
ResampleResult$help()
prediction()Combined Prediction of all individual resampling iterations, and all provided predict sets. Note that performance measures do not operate on this object, but instead on each prediction object separately and then combine the performance scores with the aggregate function of the respective Measure.
ResampleResult$prediction(predict_sets = "test")
predict_sets(character())
Prediction.
Subset of {"train", "test"}.
predictions()List of prediction objects, sorted by resampling iteration. If multiple sets are given, these are combined to a single one for each iteration.
ResampleResult$predictions(predict_sets = "test")
predict_sets(character())
Subset of {"train", "test"}.
List of Prediction objects, one per element in predict_sets.
score()Returns a table with one row for each resampling iteration, including all involved objects:
Task, Learner, Resampling, iteration number (integer(1)), and Prediction.
Additionally, a column with the individual (per resampling iteration) performance is added
for each Measure in measures,
named with the id of the respective measure id.
If measures is NULL, measures defaults to the return value of default_measures().
ResampleResult$score( measures = NULL, ids = TRUE, conditions = FALSE, predict_sets = "test" )
ids(logical(1))
If ids is TRUE, extra columns with the ids of objects ("task_id", "learner_id", "resampling_id")
are added to the returned table.
These allow to subset more conveniently.
conditions(logical(1))
Adds condition messages ("warnings", "errors") as extra
list columns of character vectors to the returned table
predict_sets(character())
Vector of predict sets ({"train", "test"}) to construct the Prediction objects from.
Default is "test".
aggregate()Calculates and aggregates performance values for all provided measures, according to the
respective aggregation function in Measure.
If measures is NULL, measures defaults to the return value of default_measures().
ResampleResult$aggregate(measures = NULL)
Named numeric().
filter()Subsets the ResampleResult, reducing it to only keep the iterations specified in iters.
ResampleResult$filter(iters)
iters(integer())
Resampling iterations to keep.
Returns the object itself, but modified by reference.
You need to explicitly $clone() the object beforehand if you want to keeps
the object in its previous state.
clone()The objects of this class are cloneable with this method.
ResampleResult$clone(deep = FALSE)
deepWhether to make a deep clone.
# NOT RUN {
task = tsk("iris")
learner = lrn("classif.rpart")
resampling = rsmp("cv", folds = 3)
rr = resample(task, learner, resampling)
print(rr)
rr$aggregate(msr("classif.acc"))
rr$prediction()
rr$prediction()$confusion
rr$warnings
rr$errors
# }
Run the code above in your browser using DataLab