Unloads the UMAP model. This prevents the model being used with
umap_transform, but allows the temporary working directory
associated with saving or loading the model to be removed.
Arguments
- model
a UMAP model create by
umap.- cleanup
if
TRUE, attempt to delete the temporary working directory that was used in either the save or load of the model.- verbose
if
TRUE, log information to the console.
Examples
iris_train <- iris[c(1:10, 51:60), ]
iris_test <- iris[100:110, ]
# create model
model <- umap(iris_train, ret_model = TRUE, n_epochs = 20)
# save without unloading: this leaves behind a temporary working directory
model_file <- tempfile("iris_umap")
model <- save_uwot(model, file = model_file)
# The model can continue to be used
test_embedding <- umap_transform(iris_test, model)
# To manually unload the model from memory when finished and to clean up
# the working directory (this doesn't touch your model file)
unload_uwot(model)
# At this point, model cannot be used with umap_transform, this would fail:
# test_embedding2 <- umap_transform(iris_test, model)
# restore the model: this also creates a temporary working directory
model2 <- load_uwot(file = model_file)
test_embedding2 <- umap_transform(iris_test, model2)
# Unload and clean up the loaded model temp directory
unload_uwot(model2)
# clean up the model file
unlink(model_file)
# save with unloading: this deletes the temporary working directory but
# doesn't allow the model to be re-used
model3 <- umap(iris_train, ret_model = TRUE, n_epochs = 20)
model_file3 <- tempfile("iris_umap")
model3 <- save_uwot(model3, file = model_file3, unload = TRUE)