vetiver

Version, share, deploy, and monitor models.

https://github.com/rstudio/vetiver-python

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.5%) to scientific vocabulary

Keywords

mlops model-deploy model-monitoring model-versioning python

Keywords from Contributors

ecology grammar graphics
Last synced: 6 months ago · JSON representation

Repository

Version, share, deploy, and monitor models.

Basic Info
Statistics
  • Stars: 68
  • Watchers: 5
  • Forks: 18
  • Open Issues: 19
  • Releases: 12
Topics
mlops model-deploy model-monitoring model-versioning python
Created about 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Code of conduct

README.md

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 python -m pip install vetiver

And the development version from GitHub with:

python 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.

```python from vetiver import mock, VetiverModel

X, y = mock.getmockdata() model = mock.getmockmodel().fit(X, y)

v = VetiverModel(model, modelname='mockmodel', 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.

```python from pins import boardtemp from vetiver import vetiverpin_write

modelboard = boardtemp(versioned = True, allowpickleread = True) vetiverpinwrite(model_board, v) ```

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

python 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.

Owner

  • Name: RStudio
  • Login: rstudio
  • Kind: organization
  • Email: info@rstudio.org
  • Location: Boston, MA

GitHub Events

Total
  • Create event: 11
  • Release event: 1
  • Issues event: 16
  • Watch event: 6
  • Delete event: 8
  • Issue comment event: 10
  • Push event: 48
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 21
  • Fork event: 1
Last Year
  • Create event: 11
  • Release event: 1
  • Issues event: 16
  • Watch event: 6
  • Delete event: 8
  • Issue comment event: 10
  • Push event: 48
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 21
  • Fork event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 572
  • Total Committers: 14
  • Avg Commits per committer: 40.857
  • Development Distribution Score (DDS): 0.073
Past Year
  • Commits: 11
  • Committers: 1
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
isabelizimm i****n@r****m 530
Hassan Kibirige h****1@g****m 18
ganesh-k13 g****7@g****m 7
Julia Silge j****e@g****m 5
Michael Chow m****b@f****m 3
Xu Fei x****2 1
Tom Ruhland T****d@c****m 1
Tom Ruhland 6****n 1
SamEdwardes e****s@g****m 1
Randy Zwitch r****h@g****m 1
Michael Mahoney m****8@g****m 1
Gagandeep Singh s****1@g****m 1
Bill Sager w****s@s****g 1
szombatiattila a****i@a****i 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 61
  • Total pull requests: 66
  • Average time to close issues: 4 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 13
  • Total pull request authors: 6
  • Average comments per issue: 1.57
  • Average comments per pull request: 0.61
  • Merged pull requests: 63
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 9
  • Pull requests: 13
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 3 days
  • Issue authors: 5
  • Pull request authors: 1
  • Average comments per issue: 1.11
  • Average comments per pull request: 0.08
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • isabelizimm (38)
  • gsingh91 (9)
  • has2k1 (5)
  • machow (2)
  • nealrichardson (1)
  • lorenzwalthert (1)
  • xuf12 (1)
  • jnhyeon (1)
  • juliasilge (1)
  • brooklynbagel (1)
  • rhea2909 (1)
  • dsdaveh (1)
  • rundel (1)
  • M4thM4gician (1)
Pull Request Authors
  • isabelizimm (64)
  • has2k1 (9)
  • machow (2)
  • juliasilge (2)
  • M4thM4gician (2)
  • randyzwitch (1)
  • xuf12 (1)
  • mikemahoney218 (1)
Top Labels
Issue Labels
enhancement (8) deploy (8) bug (7) connect (5) multilingual (4) documentation (4) monitoring (3) ci (2) question (1) help wanted (1) duplicate (1)
Pull Request Labels
enhancement (4) documentation (3) connect (2) multilingual (2) monitoring (2) ci (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,931 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 6
  • Total versions: 16
  • Total maintainers: 2
pypi.org: vetiver

Version, share, deploy, and monitor models.

  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 6
  • Downloads: 2,931 Last month
Rankings
Dependent repos count: 6.0%
Average: 8.8%
Forks count: 9.1%
Stargazers count: 9.4%
Downloads: 9.4%
Dependent packages count: 10.0%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v3 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/precommit.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pre-commit/action v2.0.3 composite
.github/workflows/tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/weekly.yml actions
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v2 composite
docker-compose.yml docker
  • rstudio/rstudio-connect latest
examples/coffeeratings/Dockerfile docker
  • python 3.8 build
examples/coffeeratings/vetiver_requirements.txt pypi
  • anyio ==3.5.0
  • asgiref ==3.5.0
  • certifi ==2021.10.8
  • charset-normalizer ==2.0.12
  • click ==8.1.2
  • fastapi ==0.75.1
  • h11 ==0.13.0
  • idna ==3.3
  • joblib ==1.1.0
  • nest-asyncio ==1.5.5
  • numpy ==1.22.3
  • pandas ==1.4.2
  • pydantic ==1.9.0
  • python-dateutil ==2.8.2
  • pytz ==2022.1
  • requests ==2.27.1
  • scikit-learn ==1.0.2
  • scipy ==1.8.0
  • six ==1.16.0
  • sniffio ==1.2.0
  • starlette ==0.17.1
  • threadpoolctl ==3.1.0
  • torch ==1.11.0
  • typing-extensions ==4.1.1
  • urllib3 ==1.26.9
  • uvicorn ==0.17.6
pyproject.toml pypi
setup.py pypi