Skip to content

Commit

Permalink
release: 0.1.1 (#25)
Browse files Browse the repository at this point in the history
* release: 0.1.1

* chore: change maintainer

* chore: remove remotes

* docs: maintainer

* chore: .Rbuildignore
  • Loading branch information
be-marc authored Dec 6, 2023
1 parent 5e55685 commit 21d9432
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 37 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@
^codemeta\.json$
^README\.Rmd$
^cran-comments\.md$
^CRAN-SUBMISSION$
11 changes: 6 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
Package: mlr3batchmark
Title: Batch Experiments for 'mlr3'
Version: 0.1.0
Authors@R:
person("Michel", "Lang", , "[email protected]", role = c("cre", "aut"),
Version: 0.1.1
Authors@R: c(
person("Marc", "Becker", , "[email protected]", role = c("cre", "aut"),
comment = c(ORCID = "0000-0002-8115-0400")),
person("Michel", "Lang", , "[email protected]", role = "aut",
comment = c(ORCID = "0000-0001-9754-0393"))
)
Description: Extends the 'mlr3' package with a connector to the package
'batchtools'. This allows to run large-scale benchmark experiments on
scheduled high-performance computing clusters.
Expand All @@ -24,8 +27,6 @@ Imports:
Suggests:
rpart,
testthat
Remotes:
mlr-org/mlr3@release
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
7 changes: 3 additions & 4 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# mlr3batchmark 0.1.0-9000
# mlr3batchmark 0.1.1

* `mlr3batchmark` now depends on package `batchtools` to avoid having to load
batchtools explicitly
* feat: `mlr3batchmark` now depends on package `batchtools` to avoid having to load `batchtools` explicitly.

# mlr3batchmark 0.1.0

Initial release
* release: Initial release

21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ computing clusters.
The package comes with two core functions for switching between `mlr3`
and `batchtools` to perform a benchmark:

- After creating a `design` object (as required for `mlr3`’s
- After creating a `design` object (as required for `mlr3`’s
`benchmark()` function), instead of `benchmark()` call `batchmark()`
which populates an `ExperimentRegistry` for the computational jobs
of the benchmark. You are now in the world of `batchtools` where you
can selectively submit jobs with different resources, monitor the
progress or resubmit as needed.
- After the computations are finished, collect the results with
- After the computations are finished, collect the results with
`reduceResultsBatchmark()` to return to `mlr3`. The resulting object
is a regular `BenchmarkResult`.

Expand All @@ -46,7 +46,7 @@ reg = makeExperimentRegistry(NA)

## No readable configuration file found

## Created registry in '/tmp/RtmpDDRpP5/registry8cb13002568c' using cluster functions 'Interactive'
## Created registry in '/tmp/Rtmp8DlMZQ/registry704553adf7a88' using cluster functions 'Interactive'

``` r
ids = batchmark(design, reg = reg)
Expand All @@ -56,7 +56,7 @@ ids = batchmark(design, reg = reg)

## Adding problem 'b39ef23a66b1f1ee'

## Exporting new objects: 'e6b8ac3a61de1b96' ...
## Exporting new objects: '5ec484de3f93431b' ...

## Exporting new objects: '7c35d835f3dfae37' ...

Expand All @@ -66,7 +66,7 @@ ids = batchmark(design, reg = reg)

## Adding problem '76c4fc7a533d41b7'

## Exporting new objects: '22f85f1b30b9a49c' ...
## Exporting new objects: 'b209de197d6cbe75' ...

## Adding 6 experiments ('76c4fc7a533d41b7'[1] x 'run_learner'[2] x repls[3]) ...

Expand All @@ -76,18 +76,11 @@ submitJobs()

## Submitting 12 jobs in 12 chunks using cluster functions 'Interactive' ...

## Submitting [=============================>---------------------] 58% eta:
## 0sSubmitting [=================================>-----------------] 67% eta:
## 0sSubmitting [=====================================>-------------] 75% eta:
## 0sSubmitting [=========================================>---------] 83% eta:
## 0sSubmitting [==============================================>----] 92% eta:
## 0sSubmitting [===================================================] 100% eta: 0s

``` r
getStatus()
```

## Status for 12 jobs at 2023-10-16 09:49:35:
## Status for 12 jobs at 2023-11-13 19:32:20:
## Submitted : 12 (100.0%)
## -- Queued : 0 ( 0.0%)
## -- Started : 12 (100.0%)
Expand All @@ -109,5 +102,5 @@ reduceResultsBatchmark()

## Resources

- The *Large-Scale Benchmarking* chapter of the [mlr3
- The *Large-Scale Benchmarking* chapter of the [mlr3
book](https://mlr3book.mlr-org.com/)
26 changes: 13 additions & 13 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
aut
BenchmarkResult
Benchmarking
ExperimentRegistry
Mattermost
ORCID
ResampleResult
StackOverflow
analyse
batchmark
batchtools
BugReports
cre
github
gmail
https
michellang
cmd
integerish
mlr
ORCID
Roxygen
RoxygenNote
rpart
testthat
uuid
param
robustify
’s
7 changes: 6 additions & 1 deletion man/mlr3batchmark-package.Rd

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

0 comments on commit 21d9432

Please sign in to comment.