Skip to content

Commit

Permalink
fix link in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mllg committed Nov 21, 2022
1 parent e92a0d0 commit ddd1f10
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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).
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.

<!-- end list -->
- 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(
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).

0 comments on commit ddd1f10

Please sign in to comment.