Skip to main content

Version, share, deploy, and monitor models.

Project description

vetiver

Lifecycle: experimental codecov

Vetiver, the oil of tranquility, is used as a stabilizing ingredient in perfumery to preserve more volatile fragrances.

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, and available for both Python and R. To learn more about vetiver, see:

You can use vetiver with:

Installation

You can install the released version of vetiver from PyPI:

python -m pip install vetiver

And the development version from GitHub with:

python -m pip install git+https://github.com/rstudio/vetiver-python

Example

A VetiverModel() object collects the information needed to store, version, and deploy a trained model.

from vetiver import mock, VetiverModel

X, y = mock.get_mock_data()
model = mock.get_mock_model().fit(X, y)

v = VetiverModel(model, model_name='mock_model', prototype_data=X)

You can version and share your VetiverModel() by choosing a pins "board" for it, including a local folder, Connect, Amazon S3, and more.

from pins import board_temp
from vetiver import vetiver_pin_write

model_board = board_temp(versioned = True, allow_pickle_read = True)
vetiver_pin_write(model_board, v)

You can deploy your pinned VetiverModel() using VetiverAPI(), an extension of FastAPI.

from vetiver import VetiverAPI
app = VetiverAPI(v, check_prototype = True)

To start a server using this object, use app.run(port = 8080) or your port of choice.

Contributing

This project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

  • For questions and discussions about deploying models, statistical modeling, and machine learning, please post on Posit Community.

  • If you think you have encountered a bug, please submit an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vetiver-0.2.6.tar.gz (292.3 kB view details)

Uploaded Source

Built Distribution

vetiver-0.2.6-py3-none-any.whl (113.9 kB view details)

Uploaded Python 3

File details

Details for the file vetiver-0.2.6.tar.gz.

File metadata

  • Download URL: vetiver-0.2.6.tar.gz
  • Upload date:
  • Size: 292.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for vetiver-0.2.6.tar.gz
Algorithm Hash digest
SHA256 10c04747114e61168fede498fdaf441e78794554433ef66d61ffcda478e1d955
MD5 b8b1e6234e4652ca40c3894d714a7659
BLAKE2b-256 d3a2a4e14ace7ff6eb30f59ef043448918cf117c26928dae8116213e12a86883

See more details on using hashes here.

File details

Details for the file vetiver-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: vetiver-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 113.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for vetiver-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4c6713ee60b0c523b805b6cfb4612c97ec38cc9c88f618bf40a00539f622fa04
MD5 10d4522ef4ef9a20b309af21987f010d
BLAKE2b-256 330875fff3507fc365444fe16e88da2470601dfd83272a12058cff45e4b931b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page