-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathgrids.R
More file actions
423 lines (386 loc) · 9.5 KB
/
grids.R
File metadata and controls
423 lines (386 loc) · 9.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
#' Create grids of tuning parameters
#'
#' Random and regular grids can be created for any number of parameter objects.
#'
#' @param x A `param` object, list, or `parameters`.
#' @param ... One or more `param` objects (such as [mtry()] or
#' [penalty()]). None of the objects can have `unknown()` values in
#' the parameter ranges or values.
#'
#' @param levels An integer for the number of values of each parameter to use
#' to make the regular grid. `levels` can be a single integer or a vector of
#' integers that is the same length as the number of parameters in `...`.
#' `levels` can be a named integer vector, with names that match the id values
#' of parameters.
#'
#' @param size A single integer for the total number of parameter value
#' combinations returned for the random grid. If duplicate combinations are
#' generated from this size, the smaller, unique set is returned.
#'
#' @param original A logical: should the parameters be in the original units or
#' in the transformed space (if any)?
#'
#' @param filter A logical: should the parameters be filtered prior to
#' generating the grid. Must be a single expression referencing parameter
#' names that evaluates to a logical vector.
#'
#' @includeRmd man/rmd/rand_notes.md details
#'
#' @return
#'
#' A tibble. There are columns for each parameter and a row for every
#' parameter combination.
#'
#' @examples
#' # filter arg will allow you to filter subsequent grid data frame based on some condition.
#' p <- parameters(penalty(), mixture())
#' grid_regular(p)
#' grid_regular(p, filter = penalty <= .01)
#'
#' # Will fail due to unknowns:
#' # grid_regular(mtry(), min_n())
#'
#' grid_regular(penalty(), mixture())
#' grid_regular(penalty(), mixture(), levels = 3:4)
#' grid_regular(penalty(), mixture(), levels = c(mixture = 4, penalty = 3))
#' grid_random(penalty(), mixture())
#'
#' @export
grid_regular <- function(x, ..., levels = 3, original = TRUE, filter = NULL) {
dots <- list(...)
if (any(names(dots) == "size")) {
cli::cli_abort(
c(
"{.arg size} is not an argument to {.fn grid_regular}.",
i = "Did you mean {.arg levels}?"
)
)
}
UseMethod("grid_regular")
}
#' @export
#' @rdname grid_regular
grid_regular.default <- function(
x,
...,
levels = 3,
original = TRUE,
filter = NULL
) {
if (missing(x)) {
cli::cli_abort("At least one parameter object is required.")
}
cli::cli_abort(
"{.arg x} must be a {.cls param} object, list, or {.cls parameters} object,
not {.obj_type_friendly {x}}."
)
}
#' @export
#' @rdname grid_regular
grid_regular.parameters <- function(
x,
...,
levels = 3,
original = TRUE,
filter = NULL
) {
check_dots_empty()
if (nrow(x) == 0) {
cli::cli_abort("At least one parameter object is required.")
}
# check for unknowns
for (i in seq_along(x$object)) {
check_param(
x$object[[i]],
allow_na = FALSE,
allow_unknown = FALSE,
arg = x$id[i]
)
}
params <- x$object
names(params) <- x$id
grd <- make_regular_grid(
!!!params,
levels = levels,
original = original,
filter = {{ filter }}
)
names(grd) <- x$id
grd
}
#' @export
#' @rdname grid_regular
grid_regular.list <- function(
x,
...,
levels = 3,
original = TRUE,
filter = NULL
) {
check_dots_empty()
if (length(x) == 0) {
cli::cli_abort("At least one parameter object is required.")
}
# check for unknowns
param_names <- names(x)
for (i in seq_along(x)) {
check_param(
x[[i]],
allow_na = FALSE,
allow_unknown = FALSE,
arg = param_arg_name(param_names[i], x[[i]], i)
)
}
y <- parameters(x)
params <- y$object
names(params) <- y$id
grd <- make_regular_grid(
!!!params,
levels = levels,
original = original,
filter = {{ filter }}
)
names(grd) <- y$id
grd
}
#' @export
#' @rdname grid_regular
grid_regular.param <- function(
x,
...,
levels = 3,
original = TRUE,
filter = NULL
) {
# check for unknowns
param_list <- list(x, ...)
param_names <- names(param_list)
for (i in seq_along(param_list)) {
check_param(
param_list[[i]],
allow_na = FALSE,
allow_unknown = FALSE,
arg = param_arg_name(param_names[i], param_list[[i]], i)
)
}
y <- parameters(param_list)
params <- y$object
names(params) <- y$id
grd <- make_regular_grid(
!!!params,
levels = levels,
original = original,
filter = {{ filter }}
)
names(grd) <- y$id
grd
}
make_regular_grid <- function(
...,
levels = 3,
original = TRUE,
filter = NULL,
call = caller_env()
) {
check_levels(levels, call = call)
check_bool(original, call = call)
filter_quo <- enquo(filter)
param_quos <- quos(...)
params <- map(param_quos, eval_tidy)
param_names <- names(param_quos)
# check levels
p <- length(levels)
if (p > 1 && p != length(param_quos)) {
cli::cli_abort(
"{.arg levels} should have length 1 or {length(param_quos)}, not {p}.",
call = call
)
}
if (p == 1) {
param_seq <- map(params, value_seq, n = levels, original = original)
} else {
if (all(rlang::has_name(levels, names(params)))) {
levels <- levels[names(params)]
} else if (any(rlang::has_name(levels, names(params)))) {
cli::cli_abort(
"Elements of {.arg levels} should either be all named or unnamed,
not mixed.",
call = call
)
} else if (!is.null(names(levels))) {
cli::cli_abort(
"The names of {.arg levels} must match the parameter names:
{.val {names(params)}}.",
call = call
)
}
param_seq <- map2(params, as.list(levels), value_seq, original = original)
}
names(param_seq) <- param_names
parameters <- expand.grid(param_seq, stringsAsFactors = FALSE)
if (!(quo_is_null(filter_quo))) {
parameters <- dplyr::filter(parameters, !!filter_quo)
}
new_param_grid(parameters)
}
# ------------------------------------------------------------------------------
#' @export
#' @rdname grid_regular
grid_random <- function(x, ..., size = 5, original = TRUE, filter = NULL) {
dots <- list(...)
if (any(names(dots) == "levels")) {
cli::cli_abort(
c(
"{.arg levels} is not an argument to {.fn grid_random}.",
i = "Did you mean {.arg size}?"
)
)
}
UseMethod("grid_random")
}
#' @export
#' @rdname grid_regular
grid_random.default <- function(
x,
...,
size = 5,
original = TRUE,
filter = NULL
) {
if (missing(x)) {
cli::cli_abort("At least one parameter object is required.")
}
cli::cli_abort(
"{.arg x} must be a {.cls param} object, list, or {.cls parameters} object,
not {.obj_type_friendly {x}}."
)
}
#' @export
#' @rdname grid_regular
grid_random.parameters <- function(
x,
...,
size = 5,
original = TRUE,
filter = NULL
) {
check_dots_empty()
if (nrow(x) == 0) {
cli::cli_abort("At least one parameter object is required.")
}
# check for unknowns
for (i in seq_along(x$object)) {
check_param(
x$object[[i]],
allow_na = FALSE,
allow_unknown = FALSE,
arg = x$id[i]
)
}
params <- x$object
names(params) <- x$id
grd <- make_random_grid(
!!!params,
size = size,
original = original,
filter = {{ filter }}
)
names(grd) <- x$id
grd
}
#' @export
#' @rdname grid_regular
grid_random.list <- function(x, ..., size = 5, original = TRUE, filter = NULL) {
check_dots_empty()
if (length(x) == 0) {
cli::cli_abort("At least one parameter object is required.")
}
# check for unknowns
param_names <- names(x)
for (i in seq_along(x)) {
check_param(
x[[i]],
allow_na = FALSE,
allow_unknown = FALSE,
arg = param_arg_name(param_names[i], x[[i]], i)
)
}
y <- parameters(x)
params <- y$object
names(params) <- y$id
grd <- make_random_grid(
!!!params,
size = size,
original = original,
filter = {{ filter }}
)
names(grd) <- y$id
grd
}
#' @export
#' @rdname grid_regular
grid_random.param <- function(
x,
...,
size = 5,
original = TRUE,
filter = NULL
) {
param_list <- list(x, ...)
# check for unknowns
param_names <- names(param_list)
for (i in seq_along(param_list)) {
check_param(
param_list[[i]],
allow_na = FALSE,
allow_unknown = FALSE,
arg = param_arg_name(param_names[i], param_list[[i]], i)
)
}
y <- parameters(param_list)
params <- y$object
names(params) <- y$id
grd <- make_random_grid(
!!!params,
size = size,
original = original,
filter = {{ filter }}
)
names(grd) <- y$id
grd
}
make_random_grid <- function(
...,
size = 5,
original = TRUE,
filter = NULL,
call = caller_env()
) {
check_number_whole(size, min = 1, call = call)
check_bool(original, call = call)
filter_quo <- enquo(filter)
param_quos <- quos(...)
params <- map(param_quos, eval_tidy)
# for now assume equal levels
param_names <- names(param_quos)
parameters <- map(params, value_sample, n = size, original = original)
names(parameters) <- param_names
parameters <- as_tibble(parameters)
if (!(quo_is_null(filter_quo))) {
parameters <- dplyr::filter(parameters, !!filter_quo)
}
new_param_grid(parameters)
}
# ------------------------------------------------------------------------------
new_param_grid <- function(x = new_data_frame()) {
check_data_frame(x)
x <- vctrs::vec_unique(x)
size <- vctrs::vec_size(x)
# Strip down to a named list with no extra attributes. This serves
# as the core object to build the tibble from.
attributes(x) <- list(names = names(x))
tibble::new_tibble(
x = x,
nrow = size
)
}