The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.
Package website: release | dev
Universal Parameter Space Description and Tools.
::install_github("mlr-org/paradox") remotes
Create a simple ParamSet using all supported Parameter Types:
"int"
)"dbl"
)TRUE
or FALSE
("lgl"
)"fct"
)= ParamSet$new(
ps params = list(
$new(id = "z", lower = 1, upper = 3),
ParamInt$new(id = "x", lower = -10, upper = 10),
ParamDbl$new(id = "flag"),
ParamLgl$new(id = "methods", levels = c("a","b","c"))
ParamFct
) )
Draw random samples / create random design:
generate_design_random(ps, 3)
#> <Design> with 3 rows:
#> z x flag methods
#> 1: 1 7.660348 FALSE b
#> 2: 3 8.809346 FALSE c
#> 3: 2 -9.088870 FALSE b
Generate LHS Design:
requireNamespace("lhs")
#> Loading required namespace: lhs
generate_design_lhs(ps, 3)
#> <Design> with 3 rows:
#> z x flag methods
#> 1: 1 -3.984673 TRUE b
#> 2: 2 7.938035 FALSE a
#> 3: 3 1.969783 TRUE c
Generate Grid Design:
generate_design_grid(ps, resolution = 2)
#> <Design> with 24 rows:
#> z x flag methods
#> 1: 1 -10 TRUE a
#> 2: 1 -10 TRUE b
#> 3: 1 -10 TRUE c
#> 4: 1 -10 FALSE a
#> 5: 1 -10 FALSE b
#> 6: 1 -10 FALSE c
#> 7: 1 10 TRUE a
#> [ reached getOption("max.print") -- omitted 18 rows ]
Properties of the parameters within the ParamSet
:
$ids()
ps#> [1] "z" "x" "flag" "methods"
$levels
ps#> $z
#> NULL
#>
#> $x
#> NULL
#>
#> $flag
#> [1] TRUE FALSE
#>
#> $methods
#> [1] "a" "b" "c"
$nlevels
ps#> z x flag methods
#> 3 Inf 2 3
$is_number
ps#> z x flag methods
#> TRUE TRUE FALSE FALSE
$lower
ps#> z x flag methods
#> 1 -10 NA NA
$upper
ps#> z x flag methods
#> 3 10 NA NA
Check that a parameter satisfies all conditions of a
ParamSet
, using $test()
(returns
FALSE
on mismatch), $check()
(returns error
description on mismatch), and $assert()
(throws error on
mismatch):
$test(list(z = 1, x = 1))
ps#> [1] TRUE
$test(list(z = -1, x = 1))
ps#> [1] FALSE
$check(list(z = -1, x = 1))
ps#> [1] "z: Element 1 is not >= 1"
$assert(list(z = -1, x = 1))
ps#> Error in ps$assert(list(z = -1, x = 1)): Assertion on 'list(z = -1, x = 1)' failed: z: Element 1 is not >= 1.
Transformations are functions with a fixed signature.
x
A named list of parameter valuesparam_set
the ParamSet
used to create the
designTransformations can be used to change the distributions of sampled parameters. For example, to sample values between \(2^-3\) and \(2^3\) in a \(log_2\)-uniform distribution, one can sample uniformly between -3 and 3 and exponentiate the random value inside the transformation.
= ParamSet$new(
ps params = list(
$new(id = "z", lower = -3, upper = 3),
ParamInt$new(id = "x", lower = 0, upper = 1)
ParamDbl
)
)$trafo = function(x, param_set) {
ps$z = 2^x$z
xreturn(x)
}= SamplerUnif$new(ps)
ps_smplr = ps_smplr$sample(2)
x = x$transpose()
xst
xst#> [[1]]
#> [[1]]$z
#> [1] 0.125
#>
#> [[1]]$x
#> [1] 0.4137243
#>
#>
#> [[2]]
#> [[2]]$z
#> [1] 0.5
#>
#> [[2]]$x
#> [1] 0.3688455
Further documentation can be found in the mlr3book.
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.