Skip to content

Commit f509f16

Browse files
committed
better docs for response_to_frame
1 parent 60d07f5 commit f509f16

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

vetiver/helpers.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,18 @@ def _dict(pred_data):
3434

3535

3636
def response_to_frame(response: dict) -> pd.DataFrame:
37+
"""Convert API JSON response to data frame
3738
39+
Parameters
40+
----------
41+
response : dict
42+
Response from API endpoint
43+
44+
Returns
45+
-------
46+
pd.DataFrame
47+
Response translated into DataFrame
48+
"""
3849
response_df = pd.DataFrame.from_dict(response.json())
3950

4051
return response_df

0 commit comments

Comments
 (0)