diff --git a/404.html b/404.html
index 9841773..d31df3b 100644
--- a/404.html
+++ b/404.html
@@ -88,7 +88,7 @@ Page not found (404)
diff --git a/authors.html b/authors.html
index 6344aa9..cacd144 100644
--- a/authors.html
+++ b/authors.html
@@ -94,7 +94,7 @@ Citation
diff --git a/index.html b/index.html
index b40d8dd..c483882 100644
--- a/index.html
+++ b/index.html
@@ -195,7 +195,7 @@ Developers
diff --git a/news/index.html b/news/index.html
index 123816f..89f0892 100644
--- a/news/index.html
+++ b/news/index.html
@@ -51,8 +51,9 @@ Changelog
- feat: The design of
batchmark() can now include parameter settings.
- feat:
reduceResultsBatchmark gains argument fun which is passed on to batchtools::reduceResultsList. Useful for deleting model data to avoid running out of memory. Thanks to Toby Dylan Hocking @tdhock for the PR (https://github.com/mlr-org/mlr3batchmark/issues/18).
-- docs: A warning is now given when the loaded mlr3 version differs from the mlr3 version stored in the trained learners
-- feat: support marshaling
+- docs: A warning is now given when the loaded mlr3 version differs from the mlr3 version stored in the trained learners.
+- feat: Support marshaling.
+- feat: A
renv project can be passed to batchmark() that is loaded in the job environment.
@@ -76,7 +77,7 @@
diff --git a/pkgdown.yml b/pkgdown.yml
index e0a2608..a60fd59 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -1,5 +1,5 @@
pandoc: 3.1.11
-pkgdown: 2.1.0
+pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2024-08-14T10:20Z
+last_built: 2024-11-25T09:41Z
diff --git a/reference/batchmark.html b/reference/batchmark.html
index 533c275..0f8a763 100644
--- a/reference/batchmark.html
+++ b/reference/batchmark.html
@@ -67,7 +67,12 @@ Benchmark Experiments on Batch Systems
-
+
batchmark(
+ design,
+ store_models = FALSE,
+ reg = batchtools::getDefaultRegistry(),
+ renv_project = NULL
+)
@@ -76,7 +81,7 @@
Arguments
- design
(data.frame())
-Data frame (or data.table::data.table()) with three columns: "task", "learner", and "resampling".
+Data frame (or data.table::data.table()) with three columns: "task", "learner", and "resampling".
Each row defines a resampling by providing a Task, Learner and an instantiated Resampling strategy.
The helper function benchmark_grid() can assist in generating an exhaustive design (see examples) and
instantiate the Resamplings per Task.
@@ -93,10 +98,16 @@
Arguments
- reg
batchtools::ExperimentRegistry.
- renv_project
+character(1)
+Path to a renv project.
+If not NULL, the renv project is activated in the job environment.
@@ -113,23 +124,23 @@
Examples
reg = batchtools::makeExperimentRegistry(NA)
#> No readable configuration file found
-
#> Created registry in '/tmp/RtmpiZub69/registry57242d3d4705' using cluster functions 'Interactive'
+
#> Created registry in '/tmp/RtmpSrAgTU/registry56ec65e2b76b' using cluster functions 'Interactive'
batchmark(design, reg = reg)
#> Adding algorithm 'run_learner'
-
#> Adding problem '34a6beb27c3181c3'
+
#> Adding problem '60543108f51f96bb'
#> Exporting new objects: 'a3b4bd84a3ce5fce' ...
-
#> Exporting new objects: '3431cc630a37510b' ...
-
#> Exporting new objects: '838c80b890e1544a' ...
+
#> Exporting new objects: '6fe399738b0bc031' ...
+
#> Exporting new objects: '5a6e9ea78253ec9a' ...
#> Exporting new objects: 'ecf8ee265ec56766' ...
#> Overwriting previously exported object: 'ecf8ee265ec56766'
-
#> Adding 6 experiments ('34a6beb27c3181c3'[1] x 'run_learner'[2] x repls[3]) ...
+
#> Adding 6 experiments ('60543108f51f96bb'[1] x 'run_learner'[2] x repls[3]) ...
#> Exporting new objects: '681f547de0d0db2f' ...
-
#> Adding 2 experiments ('34a6beb27c3181c3'[1] x 'run_learner'[2] x repls[1]) ...
-
#> Adding problem 'c0fcb04583948144'
+
#> Adding 2 experiments ('60543108f51f96bb'[1] x 'run_learner'[2] x repls[1]) ...
+
#> Adding problem '155b32a350a89fec'
#> Exporting new objects: 'cc50b6407545c334' ...
-
#> Adding 6 experiments ('c0fcb04583948144'[1] x 'run_learner'[2] x repls[3]) ...
+
#> Adding 6 experiments ('155b32a350a89fec'[1] x 'run_learner'[2] x repls[3]) ...
#> Exporting new objects: 'e73b91a46604b440' ...
-
#> Adding 2 experiments ('c0fcb04583948144'[1] x 'run_learner'[2] x repls[1]) ...
+
#> Adding 2 experiments ('155b32a350a89fec'[1] x 'run_learner'[2] x repls[1]) ...
batchtools::submitJobs(reg = reg)
#> Submitting 16 jobs in 16 chunks using cluster functions 'Interactive' ...
@@ -158,7 +169,7 @@
Examples