Skip to content

Commit 4af943f

Browse files
committed
Update README for 20.12 release
1 parent f653fb7 commit 4af943f

File tree

1 file changed

+257
-2
lines changed

1 file changed

+257
-2
lines changed

README.md

+257-2
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,260 @@
3030

3131
# Triton Inference Server
3232

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

0 commit comments

Comments
 (0)