Skip to content

Commit dea8303

Browse files
authored
Merge pull request #36 from isabelizimm/docs-cleanup
refactor docstrings for clarity
2 parents 6c14936 + d48d768 commit dea8303

5 files changed

Lines changed: 29 additions & 23 deletions

File tree

vetiver/handlers/pytorch_vt.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from ..meta import vetiver_meta
2-
from ..ptype import _vetiver_create_ptype
2+
from ..ptype import vetiver_create_ptype
33
import numpy as np
44

55
torch_exists = True
@@ -55,7 +55,7 @@ def ptype(self):
5555
ptype : pd.DataFrame or None
5656
Zero-row DataFrame for storing data types
5757
"""
58-
ptype = _vetiver_create_ptype(self.ptype_data, self.save_ptype)
58+
ptype = vetiver_create_ptype(self.ptype_data, self.save_ptype)
5959

6060
return ptype
6161

vetiver/handlers/sklearn_vt.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
from ..ptype import _vetiver_create_ptype
1+
from ..ptype import vetiver_create_ptype
22
import pandas as pd
33
from ..meta import vetiver_meta
44
import sklearn
5-
import numpy as np
65

76
class SKLearnHandler:
87
"""Handler class for creating VetiverModels with sklearn.
@@ -50,7 +49,7 @@ def ptype(self):
5049
ptype : pd.DataFrame or None
5150
Zero-row DataFrame for storing data types
5251
"""
53-
ptype = _vetiver_create_ptype(self.ptype_data, self.save_ptype)
52+
ptype = vetiver_create_ptype(self.ptype_data, self.save_ptype)
5453
return ptype
5554

5655
def handler_startup():

vetiver/pin_read_write.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99

1010
def vetiver_pin_write(board, model: VetiverModel, versioned: bool=True):
1111
"""
12-
Write pin including VetiverModel
12+
Pin a trained VetiverModel along with other model metadata.
1313
1414
Parameters
1515
----------
16-
board: pins.BaseBoard
17-
Location for pin to be saved
16+
board:
17+
A pin board, created by `pins.board_folder()` or another `board_` function.
1818
model: vetiver.VetiverModel
1919
VetiverModel to be written to board
2020
versioned: bool
@@ -50,16 +50,20 @@ def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
5050
5151
Parameters
5252
----------
53-
board: pins.BaseBoard
54-
Board where pin is held
53+
board:
54+
A pin board, created by `pins.board_folder()` or another `board_` function.
5555
name: string
56-
Name of pin
57-
versioned: bool
58-
Whether or not the pin should be versioned
56+
Pin name
57+
version: str
58+
Retrieve a specific version of a pin.
5959
6060
Returns
6161
--------
6262
vetiver.VetiverModel
63+
64+
Notes
65+
-----
66+
If reading a board from RSConnect, the `board` argument must be in "username/modelname" format.
6367
6468
"""
6569
version = version if version is not None else _choose_version(board.pin_versions(name))

vetiver/ptype.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import pandas as pd
22
import numpy as np
33
from pydantic import BaseModel, create_model
4-
from uvicorn import Config
5-
64

75
class NoAvailablePTypeError(Exception):
86
"""
@@ -32,7 +30,7 @@ def __init__(
3230
super().__init__(self.message)
3331

3432

35-
def _vetiver_create_ptype(ptype_data, save_ptype: bool):
33+
def vetiver_create_ptype(ptype_data, save_ptype: bool):
3634
"""Create zero row structure to save data types
3735
Parameters
3836
----------

vetiver/server.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@ class VetiverAPI:
2222
Model to be deployed in API
2323
check_ptype : bool
2424
Determine if data prototype should be enforced
25-
port : int
26-
Port for deployment
27-
host :
28-
Host address
2925
app_factory :
3026
Type of API to be deployed
3127
app :
@@ -153,7 +149,16 @@ def run(self,
153149
port: int = 8000,
154150
host: str = "127.0.0.1",
155151
**kw):
156-
"""Start API"""
152+
"""
153+
Start API
154+
155+
Parameters
156+
----------
157+
port : int
158+
An integer that indicates the server port that should be listened on.
159+
host : str
160+
A valid IPv4 or IPv6 address, which the application will listen on.
161+
"""
157162
_jupyter_nb()
158163
uvicorn.run(self.app, port=port, host=host, **kw)
159164

@@ -177,13 +182,13 @@ def predict(endpoint, data: Union[dict, pd.DataFrame, pd.Series], **kw):
177182
----------
178183
endpoint :
179184
URI path to endpoint
180-
data : dict
185+
data : Union[dict, pd.DataFrame, pd.Series]
181186
Name of endpoint
182187
183188
Returns
184189
-------
185190
dict
186-
Key: endpoint_name Value: Output of endpoint_fx, in list format
191+
Endpoint_name and list of endpoint_fx output
187192
"""
188193
if isinstance(endpoint, testclient.TestClient):
189194
requester = endpoint

0 commit comments

Comments
 (0)