Package: vetiver 0.2.5.9000

Julia Silge

vetiver: Version, Share, Deploy, and Monitor Models

The goal of 'vetiver' is to provide fluent tooling to version, share, deploy, and monitor a trained model. Functions handle both recording and checking the model's input data prototype, and predicting from a remote API endpoint. The 'vetiver' package is extensible, with generics that can support many kinds of models.

Authors:Julia Silge [cre, aut], Posit Software, PBC [cph, fnd]

vetiver_0.2.5.9000.tar.gz
vetiver_0.2.5.9000.zip(r-4.5)vetiver_0.2.5.9000.zip(r-4.4)vetiver_0.2.5.9000.zip(r-4.3)
vetiver_0.2.5.9000.tgz(r-4.4-any)vetiver_0.2.5.9000.tgz(r-4.3-any)
vetiver_0.2.5.9000.tar.gz(r-4.5-noble)vetiver_0.2.5.9000.tar.gz(r-4.4-noble)
vetiver_0.2.5.9000.tgz(r-4.4-emscripten)vetiver_0.2.5.9000.tgz(r-4.3-emscripten)
vetiver.pdf |vetiver.html
vetiver/json (API)
NEWS

# Install vetiver in R:
install.packages('vetiver', repos = c('https://rstudio.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/rstudio/vetiver-r/issues

On CRAN:

44 exports 176 stars 5.40 score 47 dependencies 1 dependents 1.0k downloads

Last updated 3 months agofrom:e92be6e82ee4bb41ce91bc209a27d3f384e69b75

Exports:api_specattach_pkgsaugmentget_vetiver_dashboard_pinsglue_spec_summaryhandler_predicthandler_startupload_pkgsmap_request_bodynew_vetiver_modelpin_example_kc_housing_modelrequired_pkgsvetiver_apivetiver_compute_metricsvetiver_create_descriptionvetiver_create_metavetiver_create_ptypevetiver_create_rsconnect_bundlevetiver_dashboardvetiver_deploy_rsconnectvetiver_deploy_sagemakervetiver_endpointvetiver_endpoint_sagemakervetiver_metavetiver_modelvetiver_pin_metricsvetiver_pin_readvetiver_pin_writevetiver_plot_metricsvetiver_pr_docsvetiver_pr_postvetiver_pr_predictvetiver_prepare_dockervetiver_prepare_modelvetiver_ptypevetiver_python_requirementsvetiver_renviron_requirementsvetiver_sm_buildvetiver_sm_deletevetiver_sm_endpointvetiver_sm_modelvetiver_type_convertvetiver_write_dockervetiver_write_plumber

Dependencies:askpassbitbit64bundlebutchercerealclicliprcpp11crayoncurldigestellipsisfansifsgenericsgluehardhathmshttrjsonlitelifecyclelobstrmagrittrmimeopensslpillarpinspkgconfigprettyunitsprogresspurrrR6rapidocrappdirsreadrrlangsystibbletidyselecttzdbutf8vctrsvroomwhiskerwithryaml

Version, share, and deploy a model with vetiver

Rendered fromvetiver.Rmdusingknitr::rmarkdownon Jun 16 2024.

Last update: 2023-06-12
Started: 2021-11-17

Readme and manuals

Help Manual

Help pageTopics
Update the OpenAPI specification using model metadataapi_spec glue_spec_summary glue_spec_summary.array glue_spec_summary.data.frame glue_spec_summary.default
Fully attach or load packages for making model predictionsattach_pkgs load_pkgs
Post new data to a deployed model API endpoint and augment with predictionsaugment.vetiver_endpoint
Post new data to a deployed SageMaker model endpoint and augment with predictionsaugment.vetiver_endpoint_sagemaker
Model handler functions for API endpointhandler_predict handler_predict.default handler_predict.gam handler_predict.glm handler_predict.keras.engine.training.Model handler_predict.kproto handler_predict.Learner handler_predict.lm handler_predict.luz_module_fitted handler_predict.model_stack handler_predict.ranger handler_predict.recipe handler_predict.train handler_predict.workflow handler_predict.xgb.Booster handler_startup handler_startup.default handler_startup.gam handler_startup.keras.engine.training.Model handler_startup.Learner handler_startup.luz_module_fitted handler_startup.model_stack handler_startup.ranger handler_startup.recipe handler_startup.train handler_startup.workflow handler_startup.xgb.Booster
Identify data types for each column in an input data prototypemap_request_body
Post new data to a deployed model API endpoint and return predictionspredict.vetiver_endpoint
Post new data to a deployed SageMaker model endpoint and return predictionspredict.vetiver_endpoint_sagemaker
Create a Plumber API to predict with a deployable 'vetiver_model()' objectvetiver_api vetiver_pr_docs vetiver_pr_post
Aggregate model metrics over time for monitoringvetiver_compute_metrics
Model constructor methodsvetiver_create_description vetiver_create_description.default vetiver_create_description.gam vetiver_create_description.glm vetiver_create_description.keras.engine.training.Model vetiver_create_description.kproto vetiver_create_description.Learner vetiver_create_description.lm vetiver_create_description.luz_module_fitted vetiver_create_description.model_stack vetiver_create_description.ranger vetiver_create_description.recipe vetiver_create_description.train vetiver_create_description.workflow vetiver_create_description.xgb.Booster vetiver_prepare_model vetiver_prepare_model.default vetiver_prepare_model.gam vetiver_prepare_model.glm vetiver_prepare_model.keras.engine.training.Model vetiver_prepare_model.kproto vetiver_prepare_model.Learner vetiver_prepare_model.lm vetiver_prepare_model.luz_module_fitted vetiver_prepare_model.model_stack vetiver_prepare_model.ranger vetiver_prepare_model.recipe vetiver_prepare_model.train vetiver_prepare_model.workflow vetiver_prepare_model.xgb.Booster
Metadata constructors for 'vetiver_model()' objectvetiver_create_meta vetiver_create_meta.default vetiver_create_meta.gam vetiver_create_meta.keras.engine.training.Model vetiver_create_meta.kproto vetiver_create_meta.Learner vetiver_create_meta.luz_module_fitted vetiver_create_meta.model_stack vetiver_create_meta.ranger vetiver_create_meta.recipe vetiver_create_meta.train vetiver_create_meta.workflow vetiver_create_meta.xgb.Booster vetiver_meta
Create an Posit Connect bundle for a vetiver model APIvetiver_create_rsconnect_bundle
R Markdown format for model monitoring dashboardsget_vetiver_dashboard_pins pin_example_kc_housing_model vetiver_dashboard
Deploy a vetiver model API to Posit Connectvetiver_deploy_rsconnect
Deploy a vetiver model API to Amazon SageMakervetiver_deploy_sagemaker
Create a model API endpoint object for predictionvetiver_endpoint
Create a SageMaker model API endpoint object for predictionvetiver_endpoint_sagemaker
Create a vetiver object for deployment of a trained modelnew_vetiver_model vetiver_model
Update model metrics over time for monitoringvetiver_pin_metrics
Read and write a trained model to a board of modelsvetiver_pin_read vetiver_pin_write
Plot model metrics over time for monitoringvetiver_plot_metrics
Generate files necessary to build a Docker container for a vetiver modelvetiver_prepare_docker
Create a vetiver input data prototypevetiver_create_ptype vetiver_ptype vetiver_ptype.default vetiver_ptype.gam vetiver_ptype.glm vetiver_ptype.keras.engine.training.Model vetiver_ptype.kproto vetiver_ptype.Learner vetiver_ptype.lm vetiver_ptype.luz_module_fitted vetiver_ptype.model_stack vetiver_ptype.ranger vetiver_ptype.recipe vetiver_ptype.train vetiver_ptype.workflow vetiver_ptype.xgb.Booster
Deploy a vetiver model API to Amazon SageMaker with modular functionsvetiver_sm_build vetiver_sm_endpoint vetiver_sm_model
Delete Amazon SageMaker model, endpoint, and endpoint configurationvetiver_sm_delete
Convert new data at prediction time using input data prototypevetiver_type_convert
Write a Dockerfile for a vetiver modelvetiver_write_docker
Write a deployable Plumber file for a vetiver modelvetiver_write_plumber