Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions vetiver/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ def pin_url():
async def ping():
return {"ping": "pong"}

@app.get("/metadata")
Copy link
Contributor Author

@isabelizimm isabelizimm Apr 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was, in fact, pretty small to add! But now I wonder if we need to expose prototypes as well?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that would be a nice addition, while we're working on the API, but let's add it with an argument (for folks with high data privacy needs). I think opt-out (so defaulting to adding the prototype endpoint) is OK for this.

async def get_metadata():
return self.model.metadata.to_dict()

self.vetiver_post(
self.model.handler_predict, "predict", check_prototype=self.check_prototype
)
Expand Down
31 changes: 0 additions & 31 deletions vetiver/tests/test_ping_server.py

This file was deleted.

48 changes: 48 additions & 0 deletions vetiver/tests/test_server.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
from vetiver import mock, VetiverModel, VetiverAPI
from fastapi.testclient import TestClient
import pytest
import sys


@pytest.fixture
def vetiver_model():
X, y = mock.get_mock_data()
model = mock.get_mock_model().fit(X, y)
v = VetiverModel(
model=model,
prototype_data=X,
model_name="my_model",
versioned=None,
description="A regression model for testing purposes",
)
return v


@pytest.fixture
def client(vetiver_model):
app = VetiverAPI(vetiver_model)

return TestClient(app.app)


def test_get_ping(client):
response = client.get("/ping")
assert response.status_code == 200, response.text
assert response.json() == {"ping": "pong"}


def test_get_docs(client):
response = client.get("/__docs__")
assert response.status_code == 200, response.text


def test_get_metadata(client):
response = client.get("/metadata")
assert response.status_code == 200, response.text
assert response.json() == {
"user": {},
"version": None,
"url": None,
"required_pkgs": ["scikit-learn"],
"python_version": list(sys.version_info), # JSON will return a list
}