Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature(runner): add multiple output support #2912

Merged
merged 4 commits into from Sep 13, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion bentoml/_internal/frameworks/keras.py
Expand Up @@ -327,7 +327,7 @@ def _mapping(item: "KerasArgType") -> "tf_ext.TensorLike":

def _run_method(
runnable_self: KerasRunnable, *args: "KerasArgType"
) -> "ext.NpNDArray":
) -> "ext.NpNDArray" | t.Tuple["ext.NpNDArray", ...]:

params = Params["KerasArgType"](*args)

Expand All @@ -345,6 +345,8 @@ def _run_method(
).isinstance(res):
return t.cast("ext.NpNDArray", res.numpy())

if isinstance(res, list):
return tuple(res)
return res

return _run_method
Expand Down
2 changes: 1 addition & 1 deletion bentoml/_internal/runner/runnable.py
Expand Up @@ -150,5 +150,5 @@ def __set_name__(self, owner: t.Any, name: str):
class RunnableMethodConfig:
batchable: bool
batch_dim: tuple[int, int]
input_spec: AnyType | t.Tuple[AnyType, ...] | None = None
input_spec: AnyType | tuple[AnyType, ...] | None = None
output_spec: AnyType | None = None
4 changes: 4 additions & 0 deletions bentoml/_internal/runner/runner_handle/remote.py
Expand Up @@ -189,6 +189,10 @@ async def async_run_method(
f"Bento payload decode error: invalid Content-Type '{content_type}'."
)

if content_type == "application/vnd.bentoml.multiple_outputs":
payloads = pickle.loads(body)
return tuple(AutoContainer.from_payload(payload) for payload in payloads)

container = content_type.strip("application/vnd.bentoml.")

try:
Expand Down
27 changes: 26 additions & 1 deletion bentoml/_internal/server/runner_app.py
Expand Up @@ -181,6 +181,31 @@ async def _run(requests: t.Iterable[Request]) -> list[Response]:
*batched_params.args, **batched_params.kwargs
)

server_str = f"BentoML-Runner/{self.runner.name}/{runner_method.name}/{self.worker_index}"

# multiple output branch
if isinstance(batch_ret, tuple):
output_num = len(batch_ret)
payloadss = [
AutoContainer.batch_to_payloads(
batch_ret[idx], indices, batch_dim=output_batch_dim
)
for idx in range(output_num)
]

return [
Response(
pickle.dumps(payloads),
headers={
PAYLOAD_META_HEADER: json.dumps({}),
"Content-Type": "application/vnd.bentoml.multiple_outputs",
"Server": server_str,
},
)
for payloads in zip(*payloadss)
]

# single output branch
payloads = AutoContainer.batch_to_payloads(
batch_ret,
indices,
Expand All @@ -193,7 +218,7 @@ async def _run(requests: t.Iterable[Request]) -> list[Response]:
headers={
PAYLOAD_META_HEADER: json.dumps(payload.meta),
"Content-Type": f"application/vnd.bentoml.{payload.container}",
"Server": f"BentoML-Runner/{self.runner.name}/{runner_method.name}/{self.worker_index}",
"Server": server_str,
},
)
for payload in payloads
Expand Down
11 changes: 11 additions & 0 deletions tests/e2e/bento_server_general_features/service.py
Expand Up @@ -79,6 +79,17 @@ async def predict_ndarray_enforce_dtype(
return await py_model.predict_ndarray.async_run(inp)


@svc.api(
input=NumpyNdarray(),
output=NumpyNdarray(),
)
async def predict_ndarray_multi_output(
inp: "np.ndarray[t.Any, np.dtype[t.Any]]",
) -> "np.ndarray[t.Any, np.dtype[t.Any]]":
out1, out2 = await py_model.echo_multi_ndarray.async_run(inp, inp)
return out1 + out2


@svc.api(
input=PandasDataFrame(dtype={"col1": "int64"}, orient="records"),
output=PandasDataFrame(),
Expand Down
8 changes: 8 additions & 0 deletions tests/e2e/bento_server_general_features/tests/test_io.py
Expand Up @@ -22,6 +22,14 @@ async def test_numpy(host):
assert_status=200,
assert_data=b"[[2, 4], [6, 8]]",
)
await async_request(
"POST",
f"http://{host}/predict_ndarray_multi_output",
headers={"Content-Type": "application/json"},
data="[[1,2],[3,4]]",
assert_status=200,
assert_data=b"[[2, 4], [6, 8]]",
)
await async_request(
"POST",
f"http://{host}/predict_ndarray_enforce_shape",
Expand Down