VetiverAPI.vetiver_post

VetiverAPI.vetiver_post(
    endpoint_fx: Union[Callable, SklearnPredictionTypes],
    endpoint_name: str = None,
    **kw,
)

Define a new POST endpoint that utilizes the model’s input data.

Parameters

endpoint_fx : Union[Callable, SklearnPredictionTypes]

endpoint_name : str = None

The name of the endpoint to be created.

Examples

from vetiver import mock, VetiverModel, VetiverAPI
X, y = mock.get_mock_data()
model = mock.get_mock_model().fit(X, y)

v = VetiverModel(model=model, model_name="model", prototype_data=X)
v_api = VetiverAPI(model=v, check_prototype=True)

def sum_values(x):
    return x.sum()

v_api.vetiver_post(sum_values, "sums")