README_CN.md

(简体中文|English)

---

The goal of Paddle Serving is to provide high-performance, flexible and easy-to-use industrial-grade online inference services for machine learning developers and enterprises.Paddle Serving supports multiple protocols such as RESTful, gRPC, bRPC, and provides inference solutions under a variety of hardware and multiple operating system environments, and many famous pre-trained model examples. The core features are as follows:

• Integrate high-performance server-side inference engine Paddle Inference and mobile-side engine Paddle Lite. Models of other machine learning platforms (Caffe/TensorFlow/ONNX/PyTorch) can be migrated to paddle through x2paddle.
• There are two frameworks, namely high-performance C++ Serving and high-easy-to-use Python pipeline. The C++ Serving is based on the bRPC network framework to create a high-throughput, low-latency inference service, and its performance indicators are ahead of competing products. The Python pipeline is based on the gRPC/gRPC-Gateway network framework and the Python language to build a highly easy-to-use and high-throughput inference service. How to choose which one please see Techinical Selection.
• Support multiple protocols such as HTTP, gRPC, bRPC, and provide C++, Python, Java language SDK.
• Design and implement a high-performance inference service framework for asynchronous pipelines based on directed acyclic graph (DAG), with features such as multi-model combination, asynchronous scheduling, concurrent inference, dynamic batch, multi-card multi-stream inference, request cache, etc.
• Adapt to a variety of commonly used computing hardwares, such as x86 (Intel) CPU, ARM CPU, Nvidia GPU, Kunlun XPU, HUAWEI Ascend 310/910, HYGON DCU、Nvidia Jetson etc.
• Integrate acceleration libraries of Intel MKLDNN and Nvidia TensorRT, and low-precision and quantitative inference.
• Provide a model security deployment solution, including encryption model deployment, and authentication mechanism, HTTPs security gateway, which is used in practice.
• Support cloud deployment, provide a deployment case of Baidu Cloud Intelligent Cloud kubernetes cluster.
• Provide more than 40 classic pre-model deployment examples, such as PaddleOCR, PaddleClas, PaddleDetection, PaddleSeg, PaddleNLP, PaddleRec and other suites, and more models continue to expand.
• Supports distributed deployment of large-scale sparse parameter index models, with features such as multiple tables, multiple shards, multiple copies, local high-frequency cache, etc., and can be deployed on a single machine or clouds.
• Support service monitoring, provide prometheus-based performance statistics and port access

Tutorial and Solutions

• AIStudio tutorial(Chinese) : Paddle Serving服务化部署框架
• AIStudio OCR practice(Chinese) : 基于PaddleServing的OCR服务化部署实战
• Video tutorial(Chinese) : 深度学习服务化部署-以互联网应用为例
• Edge AI solution(Chinese) : 基于Paddle Serving&百度智能边缘BIE的边缘AI解决方案
• GOVT Q&A Solution(Chinese) : 政务问答检索式 FAQ System
• Smart Q&A Solution(Chinese) : 保险智能问答
• Semantic Indexing Solution(Chinese) : In-batch Negatives

Papers

• Paper : JiZhi: A Fast and Cost-Effective Model-As-A-Service System for Web-Scale Online Inference at Baidu
• Paper : ERNIE 3.0 TITAN: EXPLORING LARGER-SCALE KNOWLEDGE ENHANCED PRE-TRAINING FOR LANGUAGE UNDERSTANDING AND GENERATION

Documentation

Set up

This chapter guides you through the installation and deployment steps. It is strongly recommended to use Docker to deploy Paddle Serving. If you do not use docker, ignore the docker-related steps. Paddle Serving can be deployed on cloud servers using Kubernetes, running on many commonly hardwares such as ARM CPU, Intel CPU, Nvidia GPU, Kunlun XPU. The latest development kit of the develop branch is compiled and generated every day for developers to use.

• Install Paddle Serving using docker
• Build Paddle Serving from Source with Docker
• Install Paddle Serving on linux system
• Deploy Paddle Serving on Kubernetes(Chinese)
• Deploy Paddle Serving with Security gateway(Chinese)
• Deploy on more hardwares[ARM CPU、百度昆仑、华为昇腾、海光DCU、Jetson]
• Docker Images
• Download Wheel packages

Use

The first step is to call the model save interface to generate a model parameter configuration file (.prototxt), which will be used on the client and server. The second step, read the configuration and startup parameters and start the service. According to API documents and your case, the third step is to write client requests based on the SDK, and test the inference service.

• Quick Start
• Save a servable model
• Description of configuration and startup parameters
• Guide for RESTful/gRPC/bRPC APIs(Chinese)
• Infer on quantizative models
• Data format of classic models(Chinese)
• Prometheus(Chinese)
• C++ Serving(Chinese)
  • Protocols(Chinese)
  • Hot loading models
  • A/B Test
  • Encryption
  • Analyze and optimize performance(Chinese)
  • Benchmark(Chinese)
  • Multiple models in series(Chinese)
  • Request Cache(Chinese)
• Python Pipeline Overview(Chinese)
  • Architecture Design(Chinese)
  • Core Features(Chinese)
  • Performance Optimization(Chinese)
  • Benchmark(Chinese)
• Client SDK
  • Python SDK(Chinese)
  • JAVA SDK
  • C++ SDK(Chinese)
• Large-scale sparse parameter server

Developers

For Paddle Serving developers, we provide extended documents such as custom OP, level of detail(LOD) processing.

• Custom Operators
• Processing LoD Data
• FAQ(Chinese)

Model Zoo

Paddle Serving works closely with the Paddle model suite, and implements a large number of service deployment examples, including image classification, object detection, language and text recognition, Chinese part of speech, sentiment analysis, content recommendation and other types of examples, for a total of 46 models.

Image Classification & Recognition	NLP	Recommend	Face Recognition	Object Detection	OCR	Image segmentation	Keypoint Detection	Video
14	6	3	1	10	8	2	1	1

For more model examples, read Model zoo

Community

If you want to communicate with developers and other users? Welcome to join us, join the community through the following methods below.

Wechat

• WeChat scavenging

QQ

• QQ Group(Group No.：697765514)

Contribution

If you want to contribute code to Paddle Serving, please reference Contribution Guidelines

• Thanks to @loveululu for providing python API of Cube.
• Thanks to @EtachGu in updating run docker codes.
• Thanks to @BeyondYourself in complementing the gRPC tutorial, updating the FAQ doc and modifying the mdkir command
• Thanks to @mcl-stone in updating faster_rcnn benchmark
• Thanks to @cg82616424 in updating the unet benchmark modifying resize comment error
• Thanks to @cuicheng01 for providing 11 PaddleClas models
• Thanks to @Jiaqi Liu for supporting prediction for string list input
• Thanks to @Bin Lu for adding pp-shitu example

Feedback

For any feedback or to report a bug, please propose a GitHub Issue.

License

Apache 2.0 License