Skip to content

Commit dc62e70

Browse files
committed
adding install instructions to docs
1 parent e9b8b6f commit dc62e70

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

docs/source/index.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1-
vetiver 🏺
1+
vetiver
22
===================================
33
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.
44
You can use vetiver with:
55

66
- `scikit-learn <https://scikit-learn.org/stable/>`_
77
- `pytorch <https://pytorch.org/>`_
88

9+
You can install the released version of vetiver from `PyPI <https://pypi.org/project/vetiver/>`_:
10+
11+
.. code-block:: bash
12+
13+
pip install vetiver
14+
15+
And the development version from `GitHub <https://github.com/tidymodels/vetiver-python>`_ with:
16+
17+
.. code-block:: bash
18+
19+
python -m pip install git+https://github.com/tidymodels/vetiver-python
20+
21+
922
This website documents the public API of Vetiver (for Python). See the `main Vetiver website <https://juliasilge.github.io/vetiver.dev/>`_ for
1023
a more holistic introduction to the API. The left-hand sidebar lists the full public
1124
API, and the sections below (linked to the right-hand sidebar) break it into similar groups, based on task.

0 commit comments

Comments
 (0)