From ddd1f10c2602885b5be5056fb572ee9b8a49a81a Mon Sep 17 00:00:00 2001 From: Michel Lang Date: Mon, 21 Nov 2022 08:15:41 +0100 Subject: [PATCH] fix link in readme --- README.Rmd | 2 +- README.md | 29 +++++++++++------------------ 2 files changed, 12 insertions(+), 19 deletions(-) diff --git a/README.Rmd b/README.Rmd index b99a9853..b786cf5b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -117,4 +117,4 @@ xst = x$transpose() xst ``` -Further documentation can be found in the [mlr3book](https://mlr3book.mlr-org.com/05-pipelines.html). +Further documentation can be found in the [mlr3book](https://mlr3book.mlr-org.com/pipelines.html). diff --git a/README.md b/README.md index 0603cc36..ae8a58dc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # paradox -Package website: [release](https://paradox.mlr-org.com/) | +Package website: [release](https://paradox.mlr-org.com/) \| [dev](https://paradox.mlr-org.com/dev/) Universal Parameter Space Description and Tools. @@ -25,13 +25,11 @@ remotes::install_github("mlr-org/paradox") Create a simple ParamSet using all supported Parameter Types: - - integer numbers (`"int"`) - - real-valued numbers (`"dbl"`) - - truth values `TRUE` or `FALSE` (`"lgl"`) - - categorical values from a set of possible strings (`"fct"`) - - further types are only possible by using transformations. - - +- integer numbers (`"int"`) +- real-valued numbers (`"dbl"`) +- truth values `TRUE` or `FALSE` (`"lgl"`) +- categorical values from a set of possible strings (`"fct"`) +- further types are only possible by using transformations. ``` r ps = ParamSet$new( @@ -136,17 +134,12 @@ ps$assert(list(z = -1, x = 1)) Transformations are functions with a fixed signature. - - `x` A named list of parameter values - - `param_set` the `ParamSet` used to create the design +- `x` A named list of parameter values +- `param_set` the `ParamSet` used to create the design Transformations can be used to change the distributions of sampled -parameters. For example, to sample values between -![2^-3](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;2%5E-3 -"2^-3") and -![2^3](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;2%5E3 -"2^3") in a -![log\_2](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;log_2 -"log_2")-uniform distribution, one can sample uniformly between -3 and 3 +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. ``` r @@ -181,4 +174,4 @@ xst ``` Further documentation can be found in the -[mlr3book](https://mlr3book.mlr-org.com/05-pipelines.html). +[mlr3book](https://mlr3book.mlr-org.com/pipelines.html).