Skip to content

an R package implementing the grid search optimization algorithm with a zoom

License

Notifications You must be signed in to change notification settings

yukai-yang/zoomgrid

Repository files navigation

zoomgrid version 1.1.0 (Red Grid)

CRAN_Status_Badge License: GPL v3

The package implements the grid search algorithm with a zoom. The grid search algorithm with a zoom aims to help solving difficult optimization problem where there are many local optimisers inside the domain of the target function. It offers suitable initial or starting value for the following optimization procedure, provided that the global optimum exists in the neighbourhood of the initial or starting value. The grid search algorithm with a zoom saves time tremendously in cases with high-dimensional arguments.

You can also find the package on CRAN, see

zoomgrid@CRAN

and the corresponding paper

Modelling Nonlinear Vector Economic Time Series

See section 1.5.4.

How to install

You can either install the stable version from CRAN

install.packages("zoomgrid")

or install the development version from GitHub

devtools::install_github("yukai-yang/zoomgrid")

provided that the package “devtools” has been installed beforehand.

Example

After installing the package, you need to load (attach better say) it by running the code

library(zoomgrid)

You can take a look at all the available functions and data in the package

ls("package:zoomgrid")
#> [1] "build_grid"        "grid_search"       "grid_search_check"

Motivation

Consider the two-dimensional Rastrigin function, which is a non-convex function widely used for testing optimisation algorithms.

where xi ∈ [−5.12, 5.12] and A = 10. It has many local minima and its global minimum is at (0, 0) with the minimum value 0.

Diegotorquemada [Public domain], from Wikimedia Commons

Diegotorquemada [Public domain], from Wikimedia Commons

Graph source: Rastrigin function @ WIKIPEDIA.

We give the function in R:

# Rastrigin function
ndim = 2 # number of dimension
nA = 10 # parameter A
# vx in [-5.12, 5.12]

# minimizer = rep(0, ndim)
# minimum = 0
Rastrigin <- function(vx) return(nA * ndim + sum(vx*vx - nA * cos(2*pi*vx)))

Then let us try the optimization algorithms available in the optim function.

# set seed and initialize the initial or starting value
set.seed(1)
par = runif(ndim, -5.12, 5.12)
cat("start from", par)
#> start from -2.401191 -1.309451

# results from different optimization algorithms
tmp1 = optim(par = par, Rastrigin, method='Nelder-Mead')
tmp2 = optim(par = par, Rastrigin, method='BFGS')
tmp3 = optim(par = par, Rastrigin, method='L-BFGS-B')
tmp4 = optim(par = par, Rastrigin, method='SANN')

tmp1$par; tmp1$value
#> [1] -1.9899136 -0.9949483
#> [1] 4.97479
tmp2$par; tmp2$value
#> [1] -0.9949586  0.9949586
#> [1] 1.989918
tmp3$par; tmp3$value
#> [1] -1.989912e+00  2.913342e-09
#> [1] 3.979831
tmp4$par; tmp4$value
#> [1] 0.97915333 0.01486102
#> [1] 1.088185

None of them are satisfactory…

Build the grid

We need to build grid first for the grid search. For details, see

?build_grid

We build the grid by running

# build the grid
bin = c(from=-5.12, to=5.12, by=.1)
grid = build_grid(bin,bin)

Grid search

We can first try the sequential (no parallel) grid search

# serial computation
ret1 = grid_search(Rastrigin, grid, silent=FALSE)
#> 
#> ── zoomgrid version 1.1.0 (Red Grid) ───────────────────────────────────────────
#> ✔ Grid search with 0 zoom-in layers and 1 point each produced 1 result.
#> The minimiser is believed to be in the neighbourhood of -0.0199999999999996 and
#> -0.0199999999999996.
#> ℹ Elapsed: 3.763s (user: 3.742s, system: 0.017s).
ret1$par
#> [1] -0.02 -0.02

Then we run the parallel one. Parallel execution uses the future framework and works on all major platforms including Windows.

# parallel computation
ret2 = grid_search(Rastrigin, grid, num=2, parallel=TRUE, silent=FALSE)
#> 
#> ── zoomgrid version 1.1.0 (Red Grid) ───────────────────────────────────────────
#> ℹ Parallel computation runs with 2 workers.
#> ✔ Grid search with 0 zoom-in layers and 2 points each produced 2 results.
#> The minimiser is believed to be in the neighbourhood of -0.0199999999999996 and
#> -0.0199999999999996.
#> ℹ Elapsed: 2.576s (user: 0.594s, system: 0.012s).
ret2$par
#> [1] -0.02 -0.02

Try the grid search with a zoom!

# grid search with a zoom!
ret3 = grid_search(Rastrigin, grid, zoom=2, num=2, parallel=TRUE, silent=FALSE)
#> 
#> ── zoomgrid version 1.1.0 (Red Grid) ───────────────────────────────────────────
#> ℹ Parallel computation runs with 2 workers.
#> ✔ Grid search with 2 zoom-in layers and 2 points each produced 14 results.
#> The minimiser is believed to be in the neighbourhood of 5.59049615653446e-05
#> and 5.59049615653446e-05.
#> ℹ Elapsed: 4.935s (user: 1.278s, system: 0.042s).
ret3$par
#> [1] 5.590496e-05 5.590496e-05

Sometimes it is strongly recommended to check the time consumed by running the grid search first. This is extremely useful when the user is going to run on some super-computing server and need to know approximately how long it will take in order to specify the corresponding settings according to some batch system like SLURM for example. So you can do as follows

ret3 = grid_search_check(Rastrigin, grid, zoom=2, num=2, parallel=TRUE, silent=FALSE)
#> 
#> ── zoomgrid version 1.1.0 (Red Grid) ───────────────────────────────────────────
#> ℹ Parallel computation runs with 2 workers.
#> ℹ The expected time consumed by running the grid search is around 4.84089 seconds.
ret3 = grid_search(Rastrigin, grid, zoom=2, num=2, parallel=TRUE, silent=FALSE)
#> 
#> ── zoomgrid version 1.1.0 (Red Grid) ───────────────────────────────────────────
#> ℹ Parallel computation runs with 2 workers.
#> ✔ Grid search with 2 zoom-in layers and 2 points each produced 14 results.
#> The minimiser is believed to be in the neighbourhood of 5.59049615653446e-05
#> and 5.59049615653446e-05.
#> ℹ Elapsed: 4.947s (user: 1.34s, system: 0.045s).

Citation

If you use the zoomgrid package in your research, please cite both the software implementation and the underlying methodology.

Software

@Manual{,
  title        = {zoomgrid: Grid Search Algorithm with a Zoom},
  author       = {Yukai Yang},
  year         = {2019},
  note         = {R package version 1.1.0 (CRAN release 2026-02-28)},
  doi          = {10.32614/CRAN.package.zoomgrid},
  url          = {https://CRAN.R-project.org/package=zoomgrid}
}

Methodology

@PhDThesis{Yang2012PhD,
  title   = {Modelling Nonlinear Vector Economic Time Series},
  author  = {Yukai Yang},
  school  = {Aarhus University},
  address = {Aarhus, Denmark},
  year    = {2012},
  note    = {PhD thesis, Department of Economics and Business, CREATES},
  url     = {https://pure.au.dk/ws/files/428886102/Yukai_Yang_PhD_Thesis.pdf}
}

About

an R package implementing the grid search optimization algorithm with a zoom

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages