---
title: "Tuning Hyperparameters"
author: "Samuel Wilson"
date: "February 9, 2020"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Tuning Hyperparameters}
  %\VignetteEngine{knitr::rmarkdown}
  \usepackage[utf8]{inputenc}
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
backup_options <- options()
options(width = 1000)
set.seed(1991)
xgbAvail <- requireNamespace('xgboost', quietly = TRUE)
```

********
## Package Process

Machine learning projects will commonly require a user to "tune" a model's hyperparameters to find a good balance between bias and variance. Several tools are available in a data scientist's toolbox to handle this task, the most blunt of which is a grid search. A grid search gauges the model performance over a pre-defined set of hyperparameters without regard for past performance. As models increase in complexity and training time, grid searches become unwieldly.

Idealy, we would use the information from prior model evaluations to guide us in our future parameter searches. This is precisely the idea behind Bayesian Optimization, in which our prior response distribution is iteratively updated based on our best guess of where the best parameters are. The ```ParBayesianOptimization``` package does exactly this in the following process:  

  1. Initial parameter-score pairs are found  
  2. Gaussian Process is fit/updated
  3. Numerical methods are used to estimate the best parameter set  
  4. New parameter-score pairs are found  
  5. Repeat steps 2-4 until some stopping criteria is met  

********
## Practical Example

In this example, we will be using the agaricus.train dataset provided in the XGBoost package. Here, we load the packages, data, and create a folds object to be used in the scoring function.
```{r eval = xgbAvail, echo=TRUE, results = 'hide'}
library("xgboost")
library("ParBayesianOptimization")

data(agaricus.train, package = "xgboost")

Folds <- list(
    Fold1 = as.integer(seq(1,nrow(agaricus.train$data),by = 3))
  , Fold2 = as.integer(seq(2,nrow(agaricus.train$data),by = 3))
  , Fold3 = as.integer(seq(3,nrow(agaricus.train$data),by = 3))
)
```

Now we need to define the scoring function. This function should, at a minimum, return a list with a ```Score``` element, which is the model evaluation metric we want to maximize. We can also retain other pieces of information created by the scoring function by including them as named elements of the returned list. In this case, we want to retain the optimal number of rounds determined by the ```xgb.cv```:

```{r eval = xgbAvail}
scoringFunction <- function(max_depth, min_child_weight, subsample) {

  dtrain <- xgb.DMatrix(agaricus.train$data,label = agaricus.train$label)
  
  Pars <- list( 
      booster = "gbtree"
    , eta = 0.01
    , max_depth = max_depth
    , min_child_weight = min_child_weight
    , subsample = subsample
    , objective = "binary:logistic"
    , eval_metric = "auc"
  )

  xgbcv <- xgb.cv(
      params = Pars
    , data = dtrain
    , nround = 100
    , folds = Folds
    , prediction = TRUE
    , showsd = TRUE
    , early_stopping_rounds = 5
    , maximize = TRUE
            , verbose = 0)

  return(
    list( 
        Score = max(xgbcv$evaluation_log$test_auc_mean)
      , nrounds = xgbcv$best_iteration
    )
  )
}
```


Some other objects we need to define are the bounds, GP kernel and acquisition function. In this example, the kernel and acquisition function are left as the default.

  + The ```bounds``` will tell our process its search space.
  + The kernel is passed to the ```GauPro``` function ```GauPro_kernel_model``` and defines the covariance function.
  + The acquisition function defines the utility we get from using a certain parameter set.

```{r eval = xgbAvail}
bounds <- list( 
    max_depth = c(2L, 10L)
  , min_child_weight = c(1, 25)
  , subsample = c(0.25, 1)
)
```

We are now ready to put this all into the ```bayesOpt``` function. 

```{r eval = xgbAvail}
set.seed(1234)
optObj <- bayesOpt(
    FUN = scoringFunction
  , bounds = bounds
  , initPoints = 4
  , iters.n = 3
)

```

The console informs us that the process initialized by running ```scoringFunction``` 4 times. It then fit a Gaussian process to the parameter-score pairs, found the global optimum of the acquisition function, and ran ```scoringFunction``` again. This process continued until we had 7 parameter-score pairs. You can interrogate the ```bayesOpt``` object to see the results:

```{r eval = xgbAvail}
optObj$scoreSummary
```
```{r eval = xgbAvail}
getBestPars(optObj)
```

```{r revert_options, include=FALSE}
options(backup_options)
```
