Skip to content

Commit 87a0d82

Browse files
committed
book styling
1 parent 709f4f3 commit 87a0d82

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

docs/source/index.rst

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,32 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to vetiver's documentation!
6+
vetiver
77
===================================
8+
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.
9+
You can use vetiver with:
10+
11+
- scikit-learn
12+
- pytorch
813

914
.. toctree::
1015
:maxdepth: 2
1116
:caption: Contents:
1217

1318

14-
15-
Indices and tables
19+
Version
1620
==================
1721

18-
* :ref:`genindex`
19-
* :ref:`modindex`
20-
* :ref:`search`
22+
.. currentmodule:: vetiver
23+
24+
.. autosummary::
25+
:toctree: api_doc/
2126

27+
~VetiverModel
28+
~pin_read_write.vetiver_pin_read
29+
~pin_read_write.vetiver_pin_write
2230

23-
Version
31+
Deploy
2432
==================
2533

2634
.. currentmodule:: vetiver

0 commit comments

Comments
 (0)