From 95e8c3377e2b8e9b7ca1e8221e800a931ce42591 Mon Sep 17 00:00:00 2001 From: avidiyal <41489828+avidiyal@users.noreply.github.com> Date: Mon, 18 Nov 2019 15:31:07 -0800 Subject: [PATCH] onnxrt server documentation update (#2396) --- BUILD.md | 12 +----------- docs/ONNX_Runtime_Server_Usage.md | 19 ++++++++++++++++++- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/BUILD.md b/BUILD.md index 76aae2e759..a688a8382c 100644 --- a/BUILD.md +++ b/BUILD.md @@ -260,19 +260,9 @@ See more information on the OpenVINO Execution Provider [here](./docs/execution_ ./build.sh --config RelWithDebInfo --use_openvino ``` - - For Linux: - - ./build.sh --config RelWithDebInfo --use_openvino - - For Windows: - - .\build.bat --config RelWithDebInfo --use_openvino - - *Note: The default Windows CMake Generator is Visual Studio 2017, but you can also use the newer Visual Studio 2019 by passing `--cmake_generator "Visual Studio 16 2019"` to `.\build.bat`* - --use_openvino: Builds the OpenVINO Execution Provider in ONNX Runtime. + --build_server: Using this flag in addition to --use_openvino builds the OpenVINO Execution Provider with ONNX Runtime Server. * ``: Specifies the hardware target for building OpenVINO Execution Provider. Below are the options for different Intel target devices. diff --git a/docs/ONNX_Runtime_Server_Usage.md b/docs/ONNX_Runtime_Server_Usage.md index fc98846f4d..59d90c8bda 100644 --- a/docs/ONNX_Runtime_Server_Usage.md +++ b/docs/ONNX_Runtime_Server_Usage.md @@ -1,8 +1,25 @@

Note: ONNX Runtime Server is still in beta state and may not be ready for production environments.

+# How to Use build ONNX Runtime Server for Prediction +ONNX Runtime Server provides an easy way to start an inferencing server for prediction with both HTTP and GRPC endpoints. + +The CLI command to build the server is + +Default CPU: +``` +python3 /onnxruntime/tools/ci_build/build.py --build_dir /onnxruntime/build --config Release --build_server --parallel --cmake_extra_defines ONNXRUNTIME_VERSION=$(cat ./VERSION_NUMBER +``` + +Openvino EP: + +``` +python3 /onnxruntime/tools/ci_build/build.py --build_dir /onnxruntime/build --config Release --use_openvino $DEVICE --build_server --parallel --cmake_extra_defines ONNXRUNTIME_VERSION=$(cat ./VERSION_NUMBER) +``` + +where $DEVICE can be CPU_FP32,GPU_FP32,VAD-M_FP16 or MYRIAD_FP16 as per the execution provider # How to Use ONNX Runtime Server for Prediction -ONNX Runtime Server provides an easy way to start an inferencing server for prediction with both HTTP and GRPC endpoints. The CLI command to start the server is shown below: + The CLI command to start the server is shown below: ``` $ ./onnxruntime_server