forked from mlflow/mlflow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
model-registry.R
322 lines (289 loc) · 7.86 KB
/
model-registry.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
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
#' Create registered model
#'
#' Creates a new registered model in the model registry
#'
#' @param name The name of the model to create.
#' @param tags Additional metadata for the registered model (Optional).
#' @param description Description for the registered model (Optional).
#' @template roxlate-client
#' @export
mlflow_create_registered_model <- function(name, tags = NULL,
description = NULL, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"create",
client = client,
verb = "POST",
version = "2.0",
data = list(
name = forge::cast_string(name),
tags = tags,
description = description
)
)
return(response$registered_model)
}
#' Get a registered model
#'
#' Retrieves a registered model from the Model Registry.
#'
#' @param name The name of the model to retrieve.
#' @template roxlate-client
#' @export
mlflow_get_registered_model <- function(name, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"get",
client = client,
verb = "GET",
version = "2.0",
query = list(name = name)
)
return(response$registered_model)
}
#' Rename a registered model
#'
#' Renames a model in the Model Registry.
#'
#' @param name The current name of the model.
#' @param new_name The new name for the model.
#' @template roxlate-client
#' @export
mlflow_rename_registered_model <- function(name, new_name, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"rename",
client = client,
verb = "POST",
version = "2.0",
data = list(
name = forge::cast_string(name),
new_name = forge::cast_string(new_name)
)
)
return(response$registered_model)
}
#' Update a registered model
#'
#' Updates a model in the Model Registry.
#'
#' @param name The name of the registered model.
#' @param description The updated description for this registered model.
#' @template roxlate-client
#' @export
mlflow_update_registered_model <- function(name, description, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"update",
client = client,
verb = "PATCH",
version = "2.0",
data = list(
name = forge::cast_string(name),
description = forge::cast_string(description)
)
)
return(response$registered_model)
}
#' Delete registered model
#'
#' Deletes an existing registered model by name
#'
#' @param name The name of the model to delete
#' @template roxlate-client
#' @export
mlflow_delete_registered_model <- function(name, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"delete",
client = client,
verb = "DELETE",
version = "2.0",
data = list(name = forge::cast_string(name))
)
}
#' List registered models
#'
#' Retrieves a list of registered models.
#'
#' @param max_results Maximum number of registered models to retrieve.
#' @param page_token Pagination token to go to the next page based on a
#' previous query.
#' @template roxlate-client
#' @export
mlflow_list_registered_models <- function(max_results = 100, page_token = NULL,
client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"list",
client = client,
verb = "GET",
version = "2.0",
query = list(
max_results = max_results,
page_token = page_token
)
)
return(list(
registered_models = response$registered_model,
next_page_token = response$next_page_token
))
}
#' Get latest model versions
#'
#' Retrieves a list of the latest model versions for a given model.
#'
#' @param name Name of the model.
#' @param stages A list of desired stages. If the input list is NULL, return
#' latest versions for ALL_STAGES.
#' @template roxlate-client
#' @export
mlflow_get_latest_versions <- function(name, stages = list(), client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"registered-models",
"get-latest-versions",
client = client,
verb = "GET",
version = "2.0",
query = list(
name = forge::cast_string(name),
stages = forge::cast_string_list(stages)
)
)
return(response$model_versions)
}
#' Create a model version
#'
#' @param name Register model under this name.
#' @param source URI indicating the location of the model artifacts.
#' @param run_id MLflow run ID for correlation, if `source` was generated
#' by an experiment run in MLflow Tracking.
#' @param tags Additional metadata.
#' @param run_link MLflow run link - This is the exact link of the run that
#' generated this model version.
#' @param description Description for model version.
#' @template roxlate-client
#' @export
mlflow_create_model_version <- function(name, source, run_id = NULL,
tags = NULL, run_link = NULL,
description = NULL, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"model-versions",
"create",
client = client,
verb = "POST",
version = "2.0",
data = list(
name = name,
source = source,
run_id = run_id,
run_link = run_link,
description = description
)
)
return(response$model_version)
}
#' Get a model version
#'
#' @param name Name of the registered model.
#' @param version Model version number.
#' @template roxlate-client
#' @export
mlflow_get_model_version <- function(name, version, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"model-versions",
"get",
client = client,
verb = "GET",
version = "2.0",
query = list(
name = name,
version = version
)
)
return(response$model_version)
}
#' Update model version
#'
#' Updates a model version
#'
#' @param name Name of the registered model.
#' @param version Model version number.
#' @param description Description of this model version.
#' @template roxlate-client
#' @export
mlflow_update_model_version <- function(name, version, description,
client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"model-versions",
"update",
client = client,
verb = "PATCH",
version = "2.0",
data = list(
name = name,
version = version,
description = description
)
)
return(response$model_version)
}
#' Delete a model version
#'
#' @param name Name of the registered model.
#' @param version Model version number.
#' @template roxlate-client
#' @export
mlflow_delete_model_version <- function(name, version, client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"model-versions",
"delete",
client = client,
verb = "DELETE",
version = "2.0",
data = list(
name = forge::cast_string(name),
version = forge::cast_string(version)
)
)
}
#' Transition ModelVersion Stage
#'
#' Transition a model version to a different stage.
#'
#' @param name Name of the registered model.
#' @param version Model version number.
#' @param stage Transition `model_version` to this tage.
#' @param archive_existing_versions (Optional)
#' @template roxlate-client
#' @export
mlflow_transition_model_version_stage <- function(name, version, stage,
archive_existing_versions = FALSE,
client = NULL) {
client <- resolve_client(client)
response <- mlflow_rest(
"model-versions",
"transition-stage",
client = client,
verb = "POST",
version = "2.0",
data = list(
name = name,
version = version,
stage = stage,
archive_existing_versions = archive_existing_versions
)
)
return(response$model_version)
}