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

Add skeleton codes for dynamic grpc client support #213

Draft
wants to merge 8 commits into
base: maxine-poc
Choose a base branch
from
Draft
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
2 changes: 2 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ option(TRITON_ENABLE_PERF_ANALYZER_C_API "Enable Performance Analyzer C API" OFF
option(TRITON_ENABLE_PERF_ANALYZER_TFS "Enable TensorFlow Serving support for Performance Analyzer" OFF)
option(TRITON_ENABLE_PERF_ANALYZER_TS "Enable TorchServe support for Performance Analyzer" OFF)
option(TRITON_ENABLE_PERF_ANALYZER_OPENAI "Enable OpenAI support for Performance Analyzer" OFF)
option(TRITON_ENABLE_PERF_ANALYZER_DGRPC "Enable Dynamic gRPC support for Performance Analyzer" OFF)

#
# Client Options
Expand Down Expand Up @@ -129,6 +130,7 @@ ExternalProject_Add(
-DTRITON_ENABLE_PERF_ANALYZER_TFS:BOOL=${TRITON_ENABLE_PERF_ANALYZER_TFS}
-DTRITON_ENABLE_PERF_ANALYZER_TS:BOOL=${TRITON_ENABLE_PERF_ANALYZER_TS}
-DTRITON_ENABLE_PERF_ANALYZER_OPENAI:BOOL=${TRITON_ENABLE_PERF_ANALYZER_OPENAI}
-DTRITON_ENABLE_PERF_ANALYZER_DGRPC:BOOL=${TRITON_ENABLE_PERF_ANALYZER_DGRPC}
-DTRITON_MIN_CXX_STANDARD:STRING=${TRITON_MIN_CXX_STANDARD}
-DTRITON_THIRD_PARTY_INSTALL_PREFIX:STRING=${TRITON_THIRD_PARTY_INSTALL_PREFIX}
-DCMAKE_BUILD_TYPE:STRING=${CMAKE_BUILD_TYPE}
Expand Down
9 changes: 9 additions & 0 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ option(TRITON_ENABLE_PERF_ANALYZER_C_API "Enable Performance Analyzer C API" OFF
option(TRITON_ENABLE_PERF_ANALYZER_TFS "Enable TensorFlow Serving support for Performance Analyzer" OFF)
option(TRITON_ENABLE_PERF_ANALYZER_TS "Enable TorchServe support for Performance Analyzer" OFF)
option(TRITON_ENABLE_PERF_ANALYZER_OPENAI "Enable OpenAI support for Performance Analyzer" OFF)
option(TRITON_ENABLE_PERF_ANALYZER_DGRPC "Enable Dynamic gRPC support for Performance Analyzer" OFF)

#
# Feature Options
Expand Down Expand Up @@ -286,6 +287,14 @@ if(TRITON_ENABLE_PERF_ANALYZER_OPENAI)
)
endif() # TRITON_ENABLE_PERF_ANALYZER_OPENAI

if(TRITON_ENABLE_PERF_ANALYZER_DGRPC)
target_compile_definitions(
client-backend-library
PUBLIC TRITON_ENABLE_PERF_ANALYZER_DGRPC=1
)
endif() # TRITON_ENABLE_PERF_ANALYZER_DGRPC


install(
TARGETS perf_analyzer
RUNTIME DESTINATION bin
Expand Down
13 changes: 13 additions & 0 deletions src/client_backend/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ if(TRITON_ENABLE_PERF_ANALYZER_OPENAI)
add_subdirectory(openai)
endif() # TRITON_ENABLE_PERF_ANALYZER_OPENAI

if(TRITON_ENABLE_PERF_ANALYZER_DGRPC)
add_subdirectory(dynamic_grpc)
endif() # TRITON_ENABLE_PERF_ANALYZER_DGRPC

set(
CLIENT_BACKEND_SRCS
client_backend.cc
Expand Down Expand Up @@ -100,6 +104,12 @@ if(TRITON_ENABLE_PERF_ANALYZER_OPENAI)
set(OPENAI_TARGET_INCLUDE_DIRECTORY PRIVATE $<TARGET_PROPERTY:openai-client-backend-library,INCLUDE_DIRECTORIES>)
endif() # TRITON_ENABLE_PERF_ANALYZER_OPENAIs

if(TRITON_ENABLE_PERF_ANALYZER_DGRPC)
set(DGRPC_LIBRARY $<TARGET_OBJECTS:dgrpc-client-backend-library>)
set(DGRPC_TARGET_LINK_LIBRARY PUBLIC $<TARGET_PROPERTY:dgrpc-client-backend-library,LINK_LIBRARIES>)
set(DGRPC_TARGET_INCLUDE_DIRECTORY PRIVATE $<TARGET_PROPERTY:dgrpc-client-backend-library,INCLUDE_DIRECTORIES>)
endif() # TRITON_ENABLE_PERF_ANALYZER_DGRPC

add_library(
client-backend-library
${CLIENT_BACKEND_SRCS}
Expand All @@ -109,6 +119,7 @@ add_library(
${TFS_LIBRARY}
${TS_LIBRARY}
${OPENAI_LIBRARY}
${DGRPC_LIBRARY}
)

target_link_libraries(
Expand All @@ -121,6 +132,7 @@ target_link_libraries(
${TFS_TARGET_LINK_LIBRARY}
${TS_TARGET_LINK_LIBRARY}
${OPENAI_TARGET_LINK_LIBRARY}
${DGRPC_TARGET_LINK_LIBRARY}
)

target_include_directories(
Expand All @@ -131,5 +143,6 @@ target_include_directories(
${TFS_TARGET_INCLUDE_DIRECTORY}
${TS_TARGET_INCLUDE_DIRECTORY}
${OPENAI_TARGET_INCLUDE_DIRECTORY}
${DGRPC_TARGET_INCLUDE_DIRECTORY}
)

26 changes: 26 additions & 0 deletions src/client_backend/client_backend.cc
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
#include "triton_c_api/triton_c_api_backend.h"
#endif // TRITON_ENABLE_PERF_ANALYZER_C_API

#ifdef TRITON_ENABLE_PERF_ANALYZER_DGRPC
#include "dynamic_grpc/dynamic_grpc_client_backend.h"
#endif // TRITON_ENABLE_PERF_ANALYZER_DGRPC

#ifdef TRITON_ENABLE_PERF_ANALYZER_OPENAI
#include "openai/openai_client_backend.h"
#endif // TRITON_ENABLE_PERF_ANALYZER_OPENAI
Expand Down Expand Up @@ -93,6 +97,9 @@ BackendKindToString(const BackendKind kind)
case OPENAI:
return std::string("OPENAI");
break;
case DYNAMIC_GRPC:
return std::string("DYNAMIC_GRPC");
break;
default:
return std::string("UNKNOWN");
break;
Expand Down Expand Up @@ -180,6 +187,13 @@ ClientBackend::Create(
metrics_url, input_tensor_format, output_tensor_format,
&local_backend));
}
#ifdef TRITON_ENABLE_PERF_ANALYZER_DGRPC
else if (kind == DYNAMIC_GRPC) {
RETURN_IF_CB_ERROR(dynamicgrpc::DynamicGrpcClientBackend::Create(
url, protocol, ssl_options, BackendToGrpcType(compression_algorithm),
http_headers, verbose, &local_backend));
}
#endif // TRITON_ENABLE_PERF_ANALYZER_DGRPC
#ifdef TRITON_ENABLE_PERF_ANALYZER_OPENAI
else if (kind == OPENAI) {
RETURN_IF_CB_ERROR(openai::OpenAiClientBackend::Create(
Expand Down Expand Up @@ -435,6 +449,12 @@ InferInput::Create(
RETURN_IF_CB_ERROR(tritonremote::TritonInferInput::Create(
infer_input, name, dims, datatype));
}
#ifdef TRITON_ENABLE_PERF_ANALYZER_DGRPC
else if (kind == DYNAMIC_GRPC) {
RETURN_IF_CB_ERROR(dynamicgrpc::DynamicGrpcInferInput::Create(
infer_input, name, dims, datatype));
}
#endif // TRITON_ENABLE_PERF_ANALYZER_DGRPC
#ifdef TRITON_ENABLE_PERF_ANALYZER_OPENAI
else if (kind == OPENAI) {
RETURN_IF_CB_ERROR(
Expand Down Expand Up @@ -534,6 +554,12 @@ InferRequestedOutput::Create(
RETURN_IF_CB_ERROR(tritonremote::TritonInferRequestedOutput::Create(
infer_output, name, class_count, datatype));
}
#ifdef TRITON_ENABLE_PERF_ANALYZER_DGRPC
else if (kind == DYNAMIC_GRPC) {
RETURN_IF_CB_ERROR(dynamicgrpc::DynamicGrpcInferRequestedOutput::Create(
infer_output, name));
}
#endif // TRITON_ENABLE_PERF_ANALYZER_DGRPC
#ifdef TRITON_ENABLE_PERF_ANALYZER_OPENAI
else if (kind == OPENAI) {
RETURN_IF_CB_ERROR(openai::OpenAiInferRequestedOutput::Create(
Expand Down
3 changes: 2 additions & 1 deletion src/client_backend/client_backend.h
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ enum BackendKind {
TENSORFLOW_SERVING = 1,
TORCHSERVE = 2,
TRITON_C_API = 3,
OPENAI = 4
OPENAI = 4,
DYNAMIC_GRPC = 5
};
std::string BackendKindToString(const BackendKind kind);

Expand Down
71 changes: 71 additions & 0 deletions src/client_backend/dynamic_grpc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Copyright 2020-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Copyright 2020-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of NVIDIA CORPORATION nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cmake_minimum_required (VERSION 3.18)

set(
DGRPC_CLIENT_BACKEND_SRCS
dynamic_grpc_client.cc
dynamic_grpc_client_backend.cc
dynamic_grpc_infer_input.cc
)

set(
DGRPC_CLIENT_BACKEND_HDRS
dynamic_grpc_client.h
dynamic_grpc_client_backend.h
dynamic_grpc_infer_input.h
)

add_library(
dgrpc-client-backend-library EXCLUDE_FROM_ALL OBJECT
${DGRPC_CLIENT_BACKEND_SRCS}
${DGRPC_CLIENT_BACKEND_HDRS}
)

# Include header files installed by CC client
target_include_directories(
dgrpc-client-backend-library
PRIVATE
${CMAKE_INSTALL_PREFIX}/include
)

target_link_libraries(
dgrpc-client-backend-library
)
Comment on lines +56 to +58
Copy link
Contributor

Choose a reason for hiding this comment

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

This isn't necessary since you're not listing any libraries:

https://cmake.org/cmake/help/latest/command/target_link_libraries.html#overview


if(${TRITON_ENABLE_GPU})
target_include_directories(dgrpc-client-backend-library
PUBLIC ${CUDAToolkit_INCLUDE_DIRS})

# Need to enable this compilation flag, otherwise, ipc.h
# will select mock-struct as opposed to the correct cuda
# runtime header file.
target_compile_definitions(
dgrpc-client-backend-library
PUBLIC TRITON_ENABLE_GPU=1
)
endif() # TRITON_ENABLE_GPU
121 changes: 121 additions & 0 deletions src/client_backend/dynamic_grpc/dynamic_grpc_client.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
// Copyright 2020-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "dynamic_grpc_client.h"

#include <chrono>
#include <cstdint>
#include <string>

namespace triton::perfanalyzer::clientbackend::dynamicgrpc {

Error
DynamicGrpcInferResult::RequestStatus() const
{
// TODO: Not required for synchronous streaming?
return Error("Not implemented yet.");
}

Error
DynamicGrpcInferResult::Id(std::string* id) const
{
// TODO: Not required for synchronous streaming?
return Error("Not implemented yet.");
}

Error
DynamicGrpcInferResult::RawData(
const std::string& output_name, std::vector<uint8_t>& buf) const
{
// TODO
return Error("Not implemented yet.");
}

//==============================================================================
//
DynamicGrpcClient::DynamicGrpcClient(
const std::string& url, bool verbose, bool use_ssl,
const SslOptions& ssl_options)
: verbose_(verbose)
{
// TODO
std::cerr << "Not implemented yet." << std::endl;
throw PerfAnalyzerException(GENERIC_ERROR);
}

DynamicGrpcClient::~DynamicGrpcClient()
{
// TODO
std::cerr << "Not implemented yet." << std::endl;
throw PerfAnalyzerException(GENERIC_ERROR);
}

Error
DynamicGrpcClient::BidiStreamRPC(
InferResult** result, const InferOptions& options,
const std::vector<InferInput*>& inputs,
const std::vector<const InferRequestedOutput*>& outputs,
const Headers& headers, grpc_compression_algorithm compression_algorithm)
{
// TODO
return Error("Not implemented yet.");
}

Error
DynamicGrpcClient::StartStream(
OnCompleteFn callback, bool enable_stats, uint32_t stream_timeout,
const Headers& headers, grpc_compression_algorithm compression_algorithm)
{
// TODO
return Error("Not implemented yet.");
}

Error
DynamicGrpcClient::StopStream()
{
// TODO
return Error("Not implemented yet.");
}

Error
DynamicGrpcClient::PreRunProcessing(
const InferOptions& options, const std::vector<InferInput*>& inputs,
const std::vector<const InferRequestedOutput*>& outputs)
{
// TODO
return Error("Not implemented yet.");
}

Error
DynamicGrpcClient::UpdateInferStat(const tc::RequestTimers& timer)
{
// TODO
return Error("Not implemented yet.");
}

//==============================================================================

} // namespace triton::perfanalyzer::clientbackend::dynamicgrpc
Loading
Loading