Skip to content

Commit

Permalink
fix: links
Browse files Browse the repository at this point in the history
  • Loading branch information
be-marc committed Jun 26, 2023
1 parent d7cecfd commit 3ea6d45
Show file tree
Hide file tree
Showing 21 changed files with 55 additions and 55 deletions.
4 changes: 2 additions & 2 deletions R/AutoTuner.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
#' @section Resources:
#' There are several sections about hyperparameter optimization in the [mlr3book](https://mlr3book.mlr-org.com).
#'
#' * [Automate](https://mlr3book.mlr-org.com/optimization.html#sec-autotuner) the tuning.
#' * Estimate the model performance with [nested resampling](https://mlr3book.mlr-org.com/optimization.html#sec-model-performance).
#' * [Automate](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-autotuner) the tuning.
#' * Estimate the model performance with [nested resampling](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-nested-resampling).
#'
#' The [gallery](https://mlr-org.com/gallery-all-optimization.html) features a collection of case studies and demos about optimization.
#'
Expand Down
2 changes: 1 addition & 1 deletion R/Tuner.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#' @section Resources:
#' There are several sections about hyperparameter optimization in the [mlr3book](https://mlr3book.mlr-org.com).
#'
#' * Learn more about [tuners](https://mlr3book.mlr-org.com/optimization.html#sec-tuner).
#' * Learn more about [tuners](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-tuner).
#'
#' The [gallery](https://mlr-org.com/gallery-all-optimization.html) features a collection of case studies and demos about optimization.
#'
Expand Down
2 changes: 1 addition & 1 deletion R/TuningInstanceMulticrit.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#' @section Resources:
#' There are several sections about hyperparameter optimization in the [mlr3book](https://mlr3book.mlr-org.com).
#'
#' * Learn about [multi-objective optimization](https://mlr3book.mlr-org.com/optimization.html#sec-multi-metrics-tuning).
#' * Learn about [multi-objective optimization](https://mlr3book.mlr-org.com/chapters/chapter5/advanced_tuning_methods_and_black_box_optimization.html#sec-multi-metrics-tuning).
#'
#' The [gallery](https://mlr-org.com/gallery-all-optimization.html) features a collection of case studies and demos about optimization.
#'
Expand Down
6 changes: 3 additions & 3 deletions R/TuningInstanceSingleCrit.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
#' @section Resources:
#' There are several sections about hyperparameter optimization in the [mlr3book](https://mlr3book.mlr-org.com).
#'
#' * Getting started with [hyperparameter optimization](https://mlr3book.mlr-org.com/optimization.html).
#' * [Tune](https://mlr3book.mlr-org.com/optimization.html#sec-tuning-instance) a simple classification tree on the Palmer Penguins data set.
#' * Learn about [tuning spaces](https://mlr3book.mlr-org.com/technical.html#sec-tuning-space).
#' * Getting started with [hyperparameter optimization](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html).
#' * [Tune](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-model-tuning) a simple classification tree on the Sonar data set.
#' * Learn about [tuning spaces](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-defining-search-spaces).
#'
#' The [gallery](https://mlr-org.com/gallery-all-optimization.html) features a collection of case studies and demos about optimization.
#'
Expand Down
4 changes: 2 additions & 2 deletions R/tune.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
#' @section Resources:
#' There are several sections about hyperparameter optimization in the [mlr3book](https://mlr3book.mlr-org.com).
#'
#' * Simplify tuning with the [`tune()`](https://mlr3book.mlr-org.com/optimization.html#sec-simplified-tuning) function.
#' * Learn about [tuning spaces](https://mlr3book.mlr-org.com/technical.html#sec-tuning-space).
#' * Simplify tuning with the [`tune()`](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-autotuner) function.
#' * Learn about [tuning spaces](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-defining-search-spaces).
#'
#' The [gallery](https://mlr-org.com/gallery-all-optimization.html) features a collection of case studies and demos about optimization.
#'
Expand Down
12 changes: 6 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Package website: [release](https://mlr3tuning.mlr-org.com/) | [dev](https://mlr3
*mlr3tuning* is the hyperparameter optimization package of the [mlr3](https://mlr-org.com/) ecosystem.
It features highly configurable search spaces via the [paradox](https://github.com/mlr-org/paradox) package and finds optimal hyperparameter configurations for any mlr3 [learner](https://github.com/mlr-org/mlr3learners).
mlr3tuning works with several optimization algorithms e.g. Random Search, Iterated Racing, Bayesian Optimization (in [mlr3mbo](https://github.com/mlr-org/mlr3mbo)) and Hyperband (in [mlr3hyperband](https://github.com/mlr-org/mlr3hyperband)).
Moreover, it can [automatically](https://mlr3book.mlr-org.com/optimization.html#sec-autotuner) optimize learners and estimate the performance of optimized models with [nested resampling](https://mlr3book.mlr-org.com/optimization.html#sec-nested-resampling).
Moreover, it can [automatically](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-autotuner) optimize learners and estimate the performance of optimized models with [nested resampling](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-nested-resampling).
The package is built on the optimization framework [bbotk](https://github.com/mlr-org/bbotk).

## Extension packages
Expand All @@ -44,11 +44,11 @@ mlr3tuning is extended by the following packages.

There are several sections about hyperparameter optimization in the [mlr3book](https://mlr3book.mlr-org.com).

* Getting started with [hyperparameter optimization](https://mlr3book.mlr-org.com/optimization.html).
* [Tune](https://mlr3book.mlr-org.com/optimization.html#sec-tuning-instance) a simple classification tree on the Palmer Penguins data set.
* Learn about [tuning spaces](https://mlr3book.mlr-org.com/technical.html#sec-tuning-space).
* Estimate the model performance with [nested resampling](https://mlr3book.mlr-org.com/optimization.html#sec-model-performance).
* Learn about [multi-objective optimization](https://mlr3book.mlr-org.com/optimization.html#sec-multi-metrics-tuning).
* Getting started with [hyperparameter optimization](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html).
* [Tune](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-model-tuning) a simple classification tree on the Sonar data set.
* Learn about [tuning spaces](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-defining-search-spaces).
* Estimate the model performance with [nested resampling](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-nested-resampling).
* Learn about [multi-objective optimization](https://mlr3book.mlr-org.com/chapters/chapter5/advanced_tuning_methods_and_black_box_optimization.html#sec-multi-metrics-tuning).

The [gallery](https://mlr-org.com/gallery-all-optimization.html) features a collection of case studies and demos about optimization.

Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ Racing, Bayesian Optimization (in
[mlr3mbo](https://github.com/mlr-org/mlr3mbo)) and Hyperband (in
[mlr3hyperband](https://github.com/mlr-org/mlr3hyperband)). Moreover, it
can
[automatically](https://mlr3book.mlr-org.com/optimization.html#sec-autotuner)
[automatically](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-autotuner)
optimize learners and estimate the performance of optimized models with
[nested
resampling](https://mlr3book.mlr-org.com/optimization.html#sec-nested-resampling).
resampling](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-nested-resampling).
The package is built on the optimization framework
[bbotk](https://github.com/mlr-org/bbotk).

Expand All @@ -48,15 +48,15 @@ There are several sections about hyperparameter optimization in the
[mlr3book](https://mlr3book.mlr-org.com).

- Getting started with [hyperparameter
optimization](https://mlr3book.mlr-org.com/optimization.html).
- [Tune](https://mlr3book.mlr-org.com/optimization.html#sec-tuning-instance)
a simple classification tree on the Palmer Penguins data set.
optimization](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html).
- [Tune](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-model-tuning)
a simple classification tree on the Sonar data set.
- Learn about [tuning
spaces](https://mlr3book.mlr-org.com/technical.html#sec-tuning-space).
spaces](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-defining-search-spaces).
- Estimate the model performance with [nested
resampling](https://mlr3book.mlr-org.com/optimization.html#sec-model-performance).
resampling](https://mlr3book.mlr-org.com/chapters/chapter4/hyperparameter_optimization.html#sec-nested-resampling).
- Learn about [multi-objective
optimization](https://mlr3book.mlr-org.com/optimization.html#sec-multi-metrics-tuning).
optimization](https://mlr3book.mlr-org.com/chapters/chapter5/advanced_tuning_methods_and_black_box_optimization.html#sec-multi-metrics-tuning).

The [gallery](https://mlr-org.com/gallery-all-optimization.html)
features a collection of case studies and demos about optimization.
Expand Down Expand Up @@ -158,7 +158,7 @@ tuner$optimize(instance)
```

## cost gamma learner_param_vals x_domain classif.ce
## 1: 11.51293 -5.756463 <list[4]> <list[2]> 0.1779158
## 1: 5.756463 -5.756463 <list[4]> <list[2]> 0.1637681

The tuner returns the best hyperparameter configuration and the
corresponding measured performance.
Expand All @@ -170,17 +170,17 @@ as.data.table(instance$archive)[, .(cost, gamma, classif.ce, batch_nr, resample_
```

## cost gamma classif.ce batch_nr resample_result
## 1: 11.512925 -5.756463 0.1779158 1 <ResampleResult[21]>
## 2: 11.512925 11.512925 0.4662526 2 <ResampleResult[21]>
## 3: 5.756463 5.756463 0.4662526 3 <ResampleResult[21]>
## 4: -5.756463 -5.756463 0.4662526 4 <ResampleResult[21]>
## 5: -11.512925 0.000000 0.4662526 5 <ResampleResult[21]>
## 1: -5.756463 5.756463 0.4665977 1 <ResampleResult[21]>
## 2: 5.756463 -5.756463 0.1637681 2 <ResampleResult[21]>
## 3: 11.512925 5.756463 0.4665977 3 <ResampleResult[21]>
## 4: 5.756463 11.512925 0.4665977 4 <ResampleResult[21]>
## 5: -11.512925 -11.512925 0.4665977 5 <ResampleResult[21]>
## ---
## 21: -11.512925 -5.756463 0.4662526 21 <ResampleResult[21]>
## 22: 11.512925 0.000000 0.4662526 22 <ResampleResult[21]>
## 23: 5.756463 11.512925 0.4662526 23 <ResampleResult[21]>
## 24: 11.512925 -11.512925 0.2498965 24 <ResampleResult[21]>
## 25: -11.512925 5.756463 0.4662526 25 <ResampleResult[21]>
## 21: -5.756463 -5.756463 0.4665977 21 <ResampleResult[21]>
## 22: 11.512925 11.512925 0.4665977 22 <ResampleResult[21]>
## 23: -11.512925 11.512925 0.4665977 23 <ResampleResult[21]>
## 24: 11.512925 -5.756463 0.1637681 24 <ResampleResult[21]>
## 25: 0.000000 -5.756463 0.2599034 25 <ResampleResult[21]>

The [mlr3viz](https://mlr3viz.mlr-org.com/) package visualizes tuning
results.
Expand Down
4 changes: 2 additions & 2 deletions man/AutoTuner.Rd

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

2 changes: 1 addition & 1 deletion man/Tuner.Rd

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

2 changes: 1 addition & 1 deletion man/TuningInstanceMultiCrit.Rd

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

6 changes: 3 additions & 3 deletions man/TuningInstanceSingleCrit.Rd

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

4 changes: 2 additions & 2 deletions man/auto_tuner.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_cmaes.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_design_points.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_gensa.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_grid_search.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_irace.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_nloptr.Rd

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

2 changes: 1 addition & 1 deletion man/mlr_tuners_random_search.Rd

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

Loading

0 comments on commit 3ea6d45

Please sign in to comment.