-
Notifications
You must be signed in to change notification settings - Fork 27
/
api.R
218 lines (205 loc) · 6.91 KB
/
api.R
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
#' Create a Plumber API to predict with a deployable `vetiver_model()` object
#'
#' Use `vetiver_api()` to add a POST endpoint for predictions from a
#' trained [vetiver_model()] to a Plumber router.
#'
#' @param pr A Plumber router, such as from [plumber::pr()].
#' @param vetiver_model A deployable [vetiver_model()] object
#' @param ... Other arguments passed to `predict()`, such as prediction `type`
#' @param check_prototype Should the input data prototype stored in
#' `vetiver_model` (used for visual API documentation) also be used to check
#' new data at prediction time? Defaults to `TRUE`.
#' @param check_ptype `r lifecycle::badge("deprecated")`
#' @param all_docs Should the interactive visual API documentation be created
#' for _all_ POST endpoints in the router `pr`? This defaults to `TRUE`, and
#' assumes that all POST endpoints use the [vetiver_model()] input data
#' prototype.
#' @inheritParams plumber::pr_post
#' @inheritParams plumber::pr_set_debug
#'
#' @details You can first store and version your [vetiver_model()] with
#' [vetiver_pin_write()], and then create an API endpoint with `vetiver_api()`.
#'
#' Setting `debug = TRUE` may expose any sensitive data from your model in
#' API errors.
#'
#' Several GET endpoints will also be added to the router `pr`, depending on the
#' characteristics of the model object:
#'
#' - a `/pin-url` endpoint to return the URL of the pinned model
#' - a `/metadata` endpoint to return any metadata stored with the model
#' - a `/ping` endpoint for the API health
#' - a `/prototype` endpoint for the model's input data prototype (use
#' [cereal::cereal_from_json()]) to convert this back to a [vctrs ptype](https://vctrs.r-lib.org/articles/type-size.html)
#'
#' The function `vetiver_api()` uses:
#' - `vetiver_pr_post()` for endpoint definition and
#' - `vetiver_pr_docs()` to create visual API documentation
#'
#' These modular functions are available for more advanced use cases.
#'
#' @return A Plumber router with the prediction endpoint added.
#'
#' @examplesIf rlang::is_installed("plumber")
#'
#' cars_lm <- lm(mpg ~ ., data = mtcars)
#' v <- vetiver_model(cars_lm, "cars_linear")
#'
#' library(plumber)
#' pr() %>% vetiver_api(v)
#' ## is the same as:
#' pr() %>% vetiver_pr_post(v) %>% vetiver_pr_docs(v)
#' ## for either, next, pipe to `pr_run()`
#'
#' @export
vetiver_api <- function(pr,
vetiver_model,
path = "/predict",
debug = is_interactive(),
...) {
# `force()` all `...` arguments early; https://github.com/tidymodels/vetiver/pull/20
rlang::list2(...)
vetiver_model$model <- bundle::unbundle(vetiver_model$model)
pr <- vetiver_pr_post(
pr = pr,
vetiver_model = vetiver_model,
path = path,
debug = debug,
...
)
pr <- vetiver_pr_docs(pr = pr, vetiver_model = vetiver_model, path = path)
pr
}
#' @rdname vetiver_api
#' @export
vetiver_pr_post <- function(pr,
vetiver_model,
path = "/predict",
debug = is_interactive(),
...,
check_prototype = TRUE,
check_ptype = deprecated()) {
rlang::check_installed("plumber")
# `force()` all `...` arguments early; https://github.com/tidymodels/vetiver/pull/20
rlang::list2(...)
if (lifecycle::is_present(check_ptype)) {
lifecycle::deprecate_soft(
"0.2.0",
"vetiver_pr_post(check_ptype)",
"vetiver_pr_post(check_prototype)"
)
check_prototype <- check_ptype
}
handler_startup(vetiver_model)
pr <- plumber::pr_set_debug(pr, debug = debug)
pr <- plumber::pr_set_serializer(
pr,
serializer = plumber::serializer_unboxed_json(null = "null")
)
pr <- vetiver_pr_ping(pr)
pr <- vetiver_pr_pin_url(pr, vetiver_model)
pr <- vetiver_pr_metadata(pr, vetiver_model)
if (!check_prototype) {
vetiver_model$prototype <- NULL
}
pr <- vetiver_pr_prototype(pr, vetiver_model)
pr <- plumber::pr_post(
pr,
path = path,
handler = handler_predict(vetiver_model, ...)
)
pr
}
vetiver_pr_ping <- function(pr) {
plumber::pr_get(
pr,
path = "/ping",
handler = function() {list(status = "online", time = Sys.time())}
)
}
vetiver_pr_pin_url <- function(pr, vetiver_model) {
if (!is_null(vetiver_model$metadata$url)) {
pr <- plumber::pr_get(
pr,
path = "/pin-url",
handler = function() vetiver_model$metadata$url
)
}
pr
}
vetiver_pr_metadata <- function(pr, vetiver_model) {
plumber::pr_get(
pr,
path = "/metadata",
handler = function() vetiver_model$metadata
)
}
vetiver_pr_prototype <- function(pr, vetiver_model) {
if (!is_null(vetiver_model$prototype)) {
pr <- plumber::pr_get(
pr,
path = "/prototype",
handler = function() {
purrr::map(vetiver_model$prototype, cereal::cereal_encode)
}
)
}
pr
}
#' @rdname vetiver_api
#' @export
vetiver_pr_docs <- function(pr,
vetiver_model,
path = "/predict",
all_docs = TRUE) {
rlang::check_installed("plumber")
loadNamespace("rapidoc")
modify_spec <- function(spec) api_spec(spec, vetiver_model, path, all_docs)
pr <- plumber::pr_set_api_spec(pr, api = modify_spec)
logo <-
'<img slot="logo" src="../logo/vetiver.png"
width=55px style=\"margin-left:7px\"/>'
pr <- plumber::pr_static(pr, "/logo", system.file(package = "vetiver"))
pr <- plumber::pr_set_docs(
pr,
"rapidoc",
slots = logo,
heading_text = paste("vetiver", utils::packageVersion("vetiver")),
header_color = "#F2C6AC",
primary_color = "#8C2D2D"
)
pr
}
#' Create a Plumber API to predict with a deployable `vetiver_model()` object
#'
#' @description
#' `r lifecycle::badge("deprecated")`
#'
#' This function was deprecated to use [vetiver_api] directly instead.
#'
#' @inheritParams vetiver_api
#' @export
#' @keywords internal
vetiver_pr_predict <- function(pr,
vetiver_model,
path = "/predict",
debug = is_interactive(),
...) {
lifecycle::deprecate_stop(
"0.1.2",
"vetiver_pr_predict()",
"vetiver_api()"
)
}
local_plumber_session <- function(pr, port, docs = FALSE, env = parent.frame()) {
rlang::check_installed("plumber")
rs <- callr::r_session$new()
rs$call(
function(pr, port, docs) {
plumber::pr_run(pr = pr, port = port, docs = docs)
},
args = list(pr = pr, port = port, docs = docs)
)
withr::defer(rs$close(), envir = env)
rs
}