From db1fe34cf75edfc98aa8dc454a1af9c67b1703ad Mon Sep 17 00:00:00 2001 From: Indrajit Bhosale Date: Wed, 14 Aug 2024 10:37:15 -0700 Subject: [PATCH] Docs for GRPC Error codes --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ea710bbb7..2f89a2578 100644 --- a/README.md +++ b/README.md @@ -585,7 +585,20 @@ server side. If writing your own gRPC clients in the language of choice consult gRPC guide on [cancellation](https://grpc.io/docs/guides/cancellation/#cancelling-an-rpc-call-on-the-client-side). +### GRPC Error Status Codes +Starting from release 24.09, the Triton Python gRPC client introduces support for gRPC error codes in streaming mode, enhancing error reporting capabilities. When this feature is enabled, the Triton server will return standard gRPC error codes and subsequently close the stream after delivering an error +gRPC guide on [status-codes](https://grpc.io/docs/guides/status-codes/) +This feature is optional can be enabled by adding header with `triton_grpc_error` key and `true` as value. + +```python + triton_client = grpcclient.InferenceServerClient(triton_server_url) + # New added header key value + metadata = {"triton_grpc_error": "true"} + triton_client.start_stream( + callback=partial(callback, user_data), headers=metadata + ) +``` ## Simple Example Applications This section describes several of the simple example applications and