Skip to content

Commit f5b001c

Browse files
author
deadeyegoodwin
authored
Update README and versions for 21.03 release (#2664)
1 parent d207a3e commit f5b001c

File tree

1 file changed

+293
-2
lines changed

1 file changed

+293
-2
lines changed

README.md

+293-2
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,296 @@
3030

3131
# Triton Inference Server
3232

33-
**NOTE: You are currently on the r21.03 branch which tracks stabilization
34-
towards the next release. This branch is not usable during stabilization.**
33+
Triton Inference Server provides a cloud and edge inferencing solution
34+
optimized for both CPUs and GPUs. Triton supports an HTTP/REST and
35+
GRPC protocol that allows remote clients to request inferencing for
36+
any model being managed by the server. For edge deployments, Triton is
37+
available as a shared library with a C API that allows the full
38+
functionality of Triton to be included directly in an
39+
application.
40+
41+
## What's New in 2.8.0
42+
43+
* The Windows build now supports ONNX models.
44+
45+
* Repository agent is a new extensibility C API added to Triton that
46+
allows implementation of custom authentication, decryption,
47+
conversion, or similar operations when a model is loaded. See
48+
https://github.com/triton-inference-server/server/blob/master/docs/repository_agents.md
49+
50+
* An OpenVINO backend is added to Triton to enable the execution of
51+
OpenVINO models on CPUs.
52+
https://github.com/triton-inference-server/openvino_backend
53+
54+
* The PyTorch backend is now maintained in its own repository:
55+
https://github.com/triton-inference-server/pytorch_backend
56+
57+
* The ONNX Runtime backend is now maintained in its own repository:
58+
https://github.com/triton-inference-server/onnxruntime_backend
59+
60+
* The Jetson release of Triton now supports the system shared-memory
61+
protocol between clients and the Triton server.
62+
63+
* SSL/TLS Mutual Authentication support is added to the GRPC client
64+
library.
65+
66+
* A new Model Configuration option, "gather_kernel_buffer_threshold",
67+
can be specified to instruct Triton to use a CUDA kernel to gather
68+
inputs buffers onto the GPU. Using this option can improve inference
69+
performance for some models.
70+
71+
* The Python client libraries have been improved to more efficiently
72+
create numpy arrays for input and output tensors.
73+
74+
* The client libraries examples have been improved to more clearly
75+
describe how string and byte-blob tensors are supported by the
76+
Python Client API.
77+
https://github.com/triton-inference-server/server/blob/master/docs/client_examples.md
78+
79+
## Features
80+
81+
* [Multiple deep-learning
82+
frameworks](https://github.com/triton-inference-server/backend). Triton
83+
can manage any number and mix of models (limited by system disk and
84+
memory resources). Triton supports TensorRT, TensorFlow GraphDef,
85+
TensorFlow SavedModel, ONNX, PyTorch TorchScript and OpenVINO model
86+
formats. Both TensorFlow 1.x and TensorFlow 2.x are
87+
supported. Triton also supports TensorFlow-TensorRT and
88+
ONNX-TensorRT integrated models.
89+
90+
* [Concurrent model
91+
execution](docs/architecture.md#concurrent-model-execution). Multiple
92+
models (or multiple instances of the same model) can run
93+
simultaneously on the same GPU or on multiple GPUs.
94+
95+
* [Dynamic batching](docs/architecture.md#models-and-schedulers). For
96+
models that support batching, Triton implements multiple scheduling
97+
and batching algorithms that combine individual inference requests
98+
together to improve inference throughput. These scheduling and
99+
batching decisions are transparent to the client requesting
100+
inference.
101+
102+
* [Extensible
103+
backends](https://github.com/triton-inference-server/backend). In
104+
addition to deep-learning frameworks, Triton provides a *backend
105+
API* that allows Triton to be extended with any model execution
106+
logic implemented in
107+
[Python](https://github.com/triton-inference-server/python_backend)
108+
or
109+
[C++](https://github.com/triton-inference-server/backend/blob/main/README.md#triton-backend-api),
110+
while still benefiting from the CPU and GPU support, concurrent
111+
execution, dynamic batching and other features provided by Triton.
112+
113+
* [Model pipelines](docs/architecture.md#ensemble-models). Triton
114+
*ensembles* represents a pipeline of one or more models and the
115+
connection of input and output tensors between those models. A
116+
single inference request to an ensemble will trigger the execution
117+
of the entire pipeline.
118+
119+
* [HTTP/REST and GRPC inference
120+
protocols](docs/inference_protocols.md) based on the community
121+
developed [KFServing
122+
protocol](https://github.com/kubeflow/kfserving/tree/master/docs/predict-api/v2).
123+
124+
* A [C API](docs/inference_protocols.md#c-api) allows Triton to be
125+
linked directly into your application for edge and other in-process
126+
use cases.
127+
128+
* [Metrics](docs/metrics.md) indicating GPU utilization, server
129+
throughput, and server latency. The metrics are provided in
130+
Prometheus data format.
131+
132+
## Documentation
133+
134+
**The master branch documentation tracks the upcoming,
135+
under-development release and so may not be accurate for the current
136+
release of Triton. See the [r21.03
137+
documentation](https://github.com/triton-inference-server/server/tree/r21.03#documentation)
138+
for the current release.**
139+
140+
[Triton Architecture](docs/architecture.md) gives a high-level
141+
overview of the structure and capabilities of the inference
142+
server. There is also an [FAQ](docs/faq.md). Additional documentation
143+
is divided into [*user*](#user-documentation) and
144+
[*developer*](#developer-documentation) sections. The *user*
145+
documentation describes how to use Triton as an inference solution,
146+
including information on how to configure Triton, how to organize and
147+
configure your models, how to use the C++ and Python clients, etc. The
148+
*developer* documentation describes how to build and test Triton and
149+
also how Triton can be extended with new functionality.
150+
151+
The Triton [Release
152+
Notes](https://docs.nvidia.com/deeplearning/triton-inference-server/release-notes/index.html)
153+
and [Support
154+
Matrix](https://docs.nvidia.com/deeplearning/dgx/support-matrix/index.html)
155+
indicate the required versions of the NVIDIA Driver and CUDA, and also
156+
describe supported GPUs.
157+
158+
### User Documentation
159+
160+
- [QuickStart](docs/quickstart.md)
161+
- [Install](docs/quickstart.md#install-triton-docker-image)
162+
- [Run](docs/quickstart.md#run-triton)
163+
- [Model Repository](docs/model_repository.md)
164+
- [Model Configuration](docs/model_configuration.md)
165+
- [Model Management](docs/model_management.md)
166+
- [Custom Operations](docs/custom_operations.md)
167+
- [Client Libraries](docs/client_libraries.md)
168+
- [Client Examples](docs/client_examples.md)
169+
- [Optimization](docs/optimization.md)
170+
- [Model Analyzer](docs/model_analyzer.md)
171+
- [Performance Analyzer](docs/perf_analyzer.md)
172+
- [Metrics](docs/metrics.md)
173+
174+
The [quickstart](docs/quickstart.md) walks you through all the steps
175+
required to install and run Triton with an example image
176+
classification model and then use an example client application to
177+
perform inferencing using that model. The quickstart also demonstrates
178+
how [Triton supports both GPU systems and CPU-only
179+
systems](docs/quickstart.md#run-triton).
180+
181+
The first step in using Triton to serve your models is to place one or
182+
more models into a [model
183+
repository](docs/model_repository.md). Optionally, depending on the type
184+
of the model and on what Triton capabilities you want to enable for
185+
the model, you may need to create a [model
186+
configuration](docs/model_configuration.md) for the model. If your
187+
model has [custom operations](docs/custom_operations.md) you will need
188+
to make sure they are loaded correctly by Triton.
189+
190+
After you have your model(s) available in Triton, you will want to
191+
send inference and other requests to Triton from your *client*
192+
application. The [Python and C++ client
193+
libraries](docs/client_libraries.md) provide
194+
[APIs](docs/client_libraries.md#client-library-apis) to simplify this
195+
communication. There are also a large number of [client
196+
examples](docs/client_examples.md) that demonstrate how to use the
197+
libraries. You can also send HTTP/REST requests directly to Triton
198+
using the [HTTP/REST JSON-based
199+
protocol](docs/inference_protocols.md#httprest-and-grpc-protocols) or
200+
[generate a GRPC client for many other
201+
languages](docs/client_libraries.md).
202+
203+
Understanding and [optimizing performance](docs/optimization.md) is an
204+
important part of deploying your models. The Triton project provides
205+
the [Performance Analyzer](docs/perf_analyzer.md) and the [Model
206+
Analyzer](docs/model_analyzer.md) to help your optimization
207+
efforts. Specifically, you will want to optimize [scheduling and
208+
batching](docs/architecture.md#models-and-schedulers) and [model
209+
instances](docs/model_configuration.md#instance-groups) appropriately
210+
for each model. You may also want to consider [ensembling multiple
211+
models and pre/post-processing](docs/architecture.md#ensemble-models)
212+
into a pipeline. In some cases you may find [individual inference
213+
request trace data](docs/trace.md) useful when optimizing. A
214+
[Prometheus metrics endpoint](docs/metrics.md) allows you to visualize
215+
and monitor aggregate inference metrics.
216+
217+
NVIDIA publishes a number of [deep learning
218+
examples](https://github.com/NVIDIA/DeepLearningExamples) that use
219+
Triton.
220+
221+
As part of your deployment strategy you may want to [explicitly manage
222+
what models are available by loading and unloading
223+
models](docs/model_management.md) from a running Triton server. If you
224+
are using Kubernetes for deployment a simple example of how to [deploy
225+
Triton using Kubernetes and Helm](deploy/single_server/README.md) may
226+
be helpful.
227+
228+
The [version 1 to version 2 migration
229+
information](docs/v1_to_v2.md) is helpful if you are moving to
230+
version 2 of Triton from previously using version 1.
231+
232+
### Developer Documentation
233+
234+
- [Build](docs/build.md)
235+
- [Protocols and APIs](docs/inference_protocols.md).
236+
- [Backends](https://github.com/triton-inference-server/backend)
237+
- [Repository Agents](docs/repository_agents.md)
238+
- [Test](docs/test.md)
239+
240+
Triton can be [built using
241+
Docker](docs/build.md#building-triton-with-docker) or [built without
242+
Docker](docs/build.md#building-triton-without-docker). After building
243+
you should [test Triton](docs/test.md).
244+
245+
Starting with the r20.10 release, it is also possible to [create a
246+
Docker image containing a customized Triton](docs/compose.md) that
247+
contains only a subset of the backends.
248+
249+
The Triton project also provides [client libraries for Python and
250+
C++](docs/client_libraries.md) that make it easy to communicate with
251+
the server. There are also a large number of [example
252+
clients](docs/client_examples.md) that demonstrate how to use the
253+
libraries. You can also develop your own clients that directly
254+
communicate with Triton using [HTTP/REST or GRPC
255+
protocols](docs/inference_protocols.md). There is also a [C
256+
API](docs/inference_protocols.md) that allows Triton to be linked
257+
directly into your application.
258+
259+
A [Triton backend](https://github.com/triton-inference-server/backend)
260+
is the implementation that executes a model. A backend can interface
261+
with a deep learning framework, like PyTorch, TensorFlow, TensorRT or
262+
ONNX Runtime; or it can interface with a data processing framework
263+
like [DALI](https://github.com/triton-inference-server/dali_backend);
264+
or you can extend Triton by [writing your own
265+
backend](https://github.com/triton-inference-server/backend) in either
266+
[C/C++](https://github.com/triton-inference-server/backend/blob/main/README.md#triton-backend-api)
267+
or
268+
[Python](https://github.com/triton-inference-server/python_backend).
269+
270+
A [Triton repository agent](docs/repository_agents.md) extends Triton
271+
with new functionality that operates when a model is loaded or
272+
unloaded. You can introduce your own code to perform authentication,
273+
decryption, conversion, or similar operations when a model is loaded.
274+
275+
## Papers and Presentation
276+
277+
* [Maximizing Deep Learning Inference Performance with NVIDIA Model
278+
Analyzer](https://developer.nvidia.com/blog/maximizing-deep-learning-inference-performance-with-nvidia-model-analyzer/).
279+
280+
* [High-Performance Inferencing at Scale Using the TensorRT Inference
281+
Server](https://developer.nvidia.com/gtc/2020/video/s22418).
282+
283+
* [Accelerate and Autoscale Deep Learning Inference on GPUs with
284+
KFServing](https://developer.nvidia.com/gtc/2020/video/s22459).
285+
286+
* [Deep into Triton Inference Server: BERT Practical Deployment on
287+
NVIDIA GPU](https://developer.nvidia.com/gtc/2020/video/s21736).
288+
289+
* [Maximizing Utilization for Data Center Inference with TensorRT
290+
Inference Server](https://on-demand-gtc.gputechconf.com/gtcnew/sessionview.php?sessionName=s9438-maximizing+utilization+for+data+center+inference+with+tensorrt+inference+server).
291+
292+
* [NVIDIA TensorRT Inference Server Boosts Deep Learning
293+
Inference](https://devblogs.nvidia.com/nvidia-serves-deep-learning-inference/).
294+
295+
* [GPU-Accelerated Inference for Kubernetes with the NVIDIA TensorRT
296+
Inference Server and
297+
Kubeflow](https://www.kubeflow.org/blog/nvidia_tensorrt/).
298+
299+
## Contributing
300+
301+
Contributions to Triton Inference Server are more than welcome. To
302+
contribute make a pull request and follow the guidelines outlined in
303+
[CONTRIBUTING.md](CONTRIBUTING.md). If you have a backend, client,
304+
example or similar contribution that is not modifying the core of
305+
Triton, then you should file a PR in the [contrib
306+
repo](https://github.com/triton-inference-server/contrib).
307+
308+
## Reporting problems, asking questions
309+
310+
We appreciate any feedback, questions or bug reporting regarding this
311+
project. When help with code is needed, follow the process outlined in
312+
the Stack Overflow (https://stackoverflow.com/help/mcve)
313+
document. Ensure posted examples are:
314+
315+
* minimal – use as little code as possible that still produces the
316+
same problem
317+
318+
* complete – provide all parts needed to reproduce the problem. Check
319+
if you can strip external dependency and still show the problem. The
320+
less time we spend on reproducing problems the more time we have to
321+
fix it
322+
323+
* verifiable – test the code you're about to provide to make sure it
324+
reproduces the problem. Remove all other problems that are not
325+
related to your request/question.

0 commit comments

Comments
 (0)