From 3b234e2f5f4683e9f6aa5d799072bafc9d13a88c Mon Sep 17 00:00:00 2001 From: pat-s Date: Thu, 21 May 2020 10:11:20 +0200 Subject: [PATCH] README and gitignore --- .gitignore | 1 + README.Rmd | 6 ++++-- README.md | 31 +++++++++++++++++++++---------- pkgdown/_pkgdown.yml | 4 ++-- tic.R | 2 +- 5 files changed, 29 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index 26eaed2f6..023a178db 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,4 @@ vignettes/*.html vignettes/*.R *_cache .Rproj.user +docs/ diff --git a/README.Rmd b/README.Rmd index 26d0a4709..b83aff351 100644 --- a/README.Rmd +++ b/README.Rmd @@ -11,16 +11,18 @@ opts_chunk$set(fig.width=5, fig.height=5, cache=TRUE) # mlrMBO - +Package website: [release](https://mlrmbo.mlr-org.com/) | [dev](https://mlr3mbo.mlr-org.com/dev) Model-based optimization with [mlr](https://github.com/mlr-org/mlr/). + +[![R CMD Check via {tic}](https://github.com/mlr-org/mlrMBO/workflows/R%20CMD%20Check%20via%20{tic}/badge.svg?branch=master)](https://github.com/mlr-org/mlrMBO/actions) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/mlrMBO)](https://cran.r-project.org/package=mlrMBO) [![Travis build status](https://img.shields.io/travis/mlr-org/mlrMBO/master?logo=travis&style=flat-square&label=Linux)](https://travis-ci.org/mlr-org/mlrMBO) [![AppVeyor build status](https://img.shields.io/appveyor/ci/mlr-org/mlrMBO?label=Windows&logo=appveyor&style=flat-square)](https://ci.appveyor.com/project/mlr-org/mlrMBO) [![Coverage Status](https://img.shields.io/codecov/c/github/mlr-org/mlrMBO/master.svg)](https://codecov.io/github/mlr-org/mlrMBO?branch=master) [![Monthly RStudio CRAN Downloads](https://cranlogs.r-pkg.org/badges/mlrMBO)](https://CRAN.R-project.org/package=mlrMBO) - + * [Documentation](https://mlr-org.github.io/mlrMBO/) * [Issues, Requests and Bug Tracker](https://github.com/mlr-org/mlrMBO/issues) diff --git a/README.md b/README.md index 12d92091f..b3075ea45 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # mlrMBO - +Package website: [release](https://mlrmbo.mlr-org.com/) | +[dev](https://mlr3mbo.mlr-org.com/dev) Model-based optimization with [mlr](https://github.com/mlr-org/mlr/). + + +[![R CMD Check via +{tic}](https://github.com/mlr-org/mlrMBO/workflows/R%20CMD%20Check%20via%20%7Btic%7D/badge.svg?branch=master)](https://github.com/mlr-org/mlrMBO/actions) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/mlrMBO)](https://cran.r-project.org/package=mlrMBO) [![Travis build status](https://img.shields.io/travis/mlr-org/mlrMBO/master?logo=travis&style=flat-square&label=Linux)](https://travis-ci.org/mlr-org/mlrMBO) @@ -14,6 +19,7 @@ status](https://img.shields.io/appveyor/ci/mlr-org/mlrMBO?label=Windows&logo=app Status](https://img.shields.io/codecov/c/github/mlr-org/mlrMBO/master.svg)](https://codecov.io/github/mlr-org/mlrMBO?branch=master) [![Monthly RStudio CRAN Downloads](https://cranlogs.r-pkg.org/badges/mlrMBO)](https://CRAN.R-project.org/package=mlrMBO) + - [Documentation](https://mlr-org.github.io/mlrMBO/) - [Issues, Requests and Bug @@ -35,7 +41,7 @@ remotes::install_github("mlr-org/mlrMBO") # Introduction -![](https://i.imgur.com/NMpSqnS.gif) +![](https://i.imgur.com/LVFRVVl.gif) `mlrMBO` is a highly configurable R toolbox for model-based / Bayesian optimization of black-box functions. @@ -57,15 +63,20 @@ Features: [parallelMap](https://github.com/berndbischl/parallelMap) For the *surrogate*, `mlrMBO` allows any regression learner from -[`mlr`](https://github.com/mlr-org/mlr), including: \* Kriging aka. -Gaussian processes (i.e. `DiceKriging`) \* random Forests -(i.e. `randomForest`) \* and many more… +[`mlr`](https://github.com/mlr-org/mlr), including: + + - Kriging aka. Gaussian processes (i.e. `DiceKriging`) + - random Forests (i.e. `randomForest`) + - and many more… Various *infill criteria* (aka. *acquisition functions*) are available: -\* Expected improvement (EI) \* Upper/Lower confidence bound (LCB, aka. -statistical lower or upper bound) \* Augmented expected improvement -(AEI) \* Expected quantile improvement (EQI) \* API for custom infill -criteria + + - Expected improvement (EI) + - Upper/Lower confidence bound (LCB, aka. statistical lower or upper + bound) + - Augmented expected improvement (AEI) + - Expected quantile improvement (EQI) + - API for custom infill criteria Objective functions are created with package [smoof](https://github.com/jakobbossek/smoof), which also offers many @@ -74,7 +85,7 @@ test functions for example runs or benchmarks. Parameter spaces and initial designs are created with package [ParamHelpers](https://github.com/berndbischl/ParamHelpers). -# mlrMBO - How to Cite and Citing Publications +# How to Cite Please cite our [arxiv paper](https://arxiv.org/abs/1703.03373) (Preprint). You can get citation info via `citation("mlrMBO")` or copy diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index 9bd65614c..0fe92593c 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -7,9 +7,9 @@ template: default_assets: false development: - destination: dev + destination: auto version_label: default - version_tooltip: "Development version" + version_tooltip: "Version" navbar: structure: diff --git a/tic.R b/tic.R index 4ec7eb86b..b5217684b 100644 --- a/tic.R +++ b/tic.R @@ -5,5 +5,5 @@ if (ci_has_env("BUILD_PKGDOWN")) { add_step(step_install_github("mlr-org/mlr3pkgdowntemplate")) %>% add_step(step_install_cran("animation")) %>% add_step(step_install_cran("e1071")) - do_pkgdown(orphan = TRUE) + do_pkgdown() }