Skip to content

Commit 30230a0

Browse files
authored
Release: Update README for r24.08 (#7564)
1 parent 2831aa9 commit 30230a0

File tree

1 file changed

+230
-4
lines changed

1 file changed

+230
-4
lines changed

README.md

Lines changed: 230 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,233 @@ ___
4141

4242
[![License](https://img.shields.io/badge/License-BSD3-lightgrey.svg)](https://opensource.org/licenses/BSD-3-Clause)
4343

44-
> [!Warning]
45-
>
46-
>
47-
> You are currently on the `r24.08` branch which tracks under-development progress towards the next release. <br>
44+
##### LATEST RELEASE
45+
The current release is version [2.49.0](https://github.com/triton-inference-server/server/releases/latest) and corresponds to the 24.08 container release on NVIDIA GPU Cloud (NGC).
46+
47+
Triton Inference Server is an open source inference serving software that
48+
streamlines AI inferencing. Triton enables teams to deploy any AI model from
49+
multiple deep learning and machine learning frameworks, including TensorRT,
50+
TensorFlow, PyTorch, ONNX, OpenVINO, Python, RAPIDS FIL, and more. Triton
51+
Inference Server supports inference across cloud, data center, edge and embedded
52+
devices on NVIDIA GPUs, x86 and ARM CPU, or AWS Inferentia. Triton Inference
53+
Server delivers optimized performance for many query types, including real time,
54+
batched, ensembles and audio/video streaming. Triton inference Server is part of
55+
[NVIDIA AI Enterprise](https://www.nvidia.com/en-us/data-center/products/ai-enterprise/),
56+
a software platform that accelerates the data science pipeline and streamlines
57+
the development and deployment of production AI.
58+
59+
Major features include:
60+
61+
- [Supports multiple deep learning
62+
frameworks](https://github.com/triton-inference-server/backend#where-can-i-find-all-the-backends-that-are-available-for-triton)
63+
- [Supports multiple machine learning
64+
frameworks](https://github.com/triton-inference-server/fil_backend)
65+
- [Concurrent model
66+
execution](docs/user_guide/architecture.md#concurrent-model-execution)
67+
- [Dynamic batching](docs/user_guide/model_configuration.md#dynamic-batcher)
68+
- [Sequence batching](docs/user_guide/model_configuration.md#sequence-batcher) and
69+
[implicit state management](docs/user_guide/architecture.md#implicit-state-management)
70+
for stateful models
71+
- Provides [Backend API](https://github.com/triton-inference-server/backend) that
72+
allows adding custom backends and pre/post processing operations
73+
- Supports writing custom backends in python, a.k.a.
74+
[Python-based backends.](https://github.com/triton-inference-server/backend/blob/main/docs/python_based_backends.md#python-based-backends)
75+
- Model pipelines using
76+
[Ensembling](docs/user_guide/architecture.md#ensemble-models) or [Business
77+
Logic Scripting
78+
(BLS)](https://github.com/triton-inference-server/python_backend#business-logic-scripting)
79+
- [HTTP/REST and GRPC inference
80+
protocols](docs/customization_guide/inference_protocols.md) based on the community
81+
developed [KServe
82+
protocol](https://github.com/kserve/kserve/tree/master/docs/predict-api/v2)
83+
- A [C API](docs/customization_guide/inference_protocols.md#in-process-triton-server-api) and
84+
[Java API](docs/customization_guide/inference_protocols.md#java-bindings-for-in-process-triton-server-api)
85+
allow Triton to link directly into your application for edge and other in-process use cases
86+
- [Metrics](docs/user_guide/metrics.md) indicating GPU utilization, server
87+
throughput, server latency, and more
88+
89+
**New to Triton Inference Server?** Make use of
90+
[these tutorials](https://github.com/triton-inference-server/tutorials)
91+
to begin your Triton journey!
92+
93+
Join the [Triton and TensorRT community](https://www.nvidia.com/en-us/deep-learning-ai/triton-tensorrt-newsletter/) and
94+
stay current on the latest product updates, bug fixes, content, best practices,
95+
and more. Need enterprise support? NVIDIA global support is available for Triton
96+
Inference Server with the
97+
[NVIDIA AI Enterprise software suite](https://www.nvidia.com/en-us/data-center/products/ai-enterprise/).
98+
99+
## Serve a Model in 3 Easy Steps
100+
101+
```bash
102+
# Step 1: Create the example model repository
103+
git clone -b r24.08 https://github.com/triton-inference-server/server.git
104+
cd server/docs/examples
105+
./fetch_models.sh
106+
107+
# Step 2: Launch triton from the NGC Triton container
108+
docker run --gpus=1 --rm --net=host -v ${PWD}/model_repository:/models nvcr.io/nvidia/tritonserver:24.08-py3 tritonserver --model-repository=/models
109+
110+
# Step 3: Sending an Inference Request
111+
# In a separate console, launch the image_client example from the NGC Triton SDK container
112+
docker run -it --rm --net=host nvcr.io/nvidia/tritonserver:24.08-py3-sdk
113+
/workspace/install/bin/image_client -m densenet_onnx -c 3 -s INCEPTION /workspace/images/mug.jpg
114+
115+
# Inference should return the following
116+
Image '/workspace/images/mug.jpg':
117+
15.346230 (504) = COFFEE MUG
118+
13.224326 (968) = CUP
119+
10.422965 (505) = COFFEEPOT
120+
```
121+
Please read the [QuickStart](docs/getting_started/quickstart.md) guide for additional information
122+
regarding this example. The quickstart guide also contains an example of how to launch Triton on [CPU-only systems](docs/getting_started/quickstart.md#run-on-cpu-only-system). New to Triton and wondering where to get started? Watch the [Getting Started video](https://youtu.be/NQDtfSi5QF4).
123+
124+
## Examples and Tutorials
125+
126+
Check out [NVIDIA LaunchPad](https://www.nvidia.com/en-us/data-center/products/ai-enterprise-suite/trial/)
127+
for free access to a set of hands-on labs with Triton Inference Server hosted on
128+
NVIDIA infrastructure.
129+
130+
Specific end-to-end examples for popular models, such as ResNet, BERT, and DLRM
131+
are located in the
132+
[NVIDIA Deep Learning Examples](https://github.com/NVIDIA/DeepLearningExamples)
133+
page on GitHub. The
134+
[NVIDIA Developer Zone](https://developer.nvidia.com/nvidia-triton-inference-server)
135+
contains additional documentation, presentations, and examples.
136+
137+
## Documentation
138+
139+
### Build and Deploy
140+
141+
The recommended way to build and use Triton Inference Server is with Docker
142+
images.
143+
144+
- [Install Triton Inference Server with Docker containers](docs/customization_guide/build.md#building-with-docker) (*Recommended*)
145+
- [Install Triton Inference Server without Docker containers](docs/customization_guide/build.md#building-without-docker)
146+
- [Build a custom Triton Inference Server Docker container](docs/customization_guide/compose.md)
147+
- [Build Triton Inference Server from source](docs/customization_guide/build.md#building-on-unsupported-platforms)
148+
- [Build Triton Inference Server for Windows 10](docs/customization_guide/build.md#building-for-windows-10)
149+
- Examples for deploying Triton Inference Server with Kubernetes and Helm on [GCP](deploy/gcp/README.md),
150+
[AWS](deploy/aws/README.md), and [NVIDIA FleetCommand](deploy/fleetcommand/README.md)
151+
- [Secure Deployment Considerations](docs/customization_guide/deploy.md)
152+
153+
### Using Triton
154+
155+
#### Preparing Models for Triton Inference Server
156+
157+
The first step in using Triton to serve your models is to place one or
158+
more models into a [model repository](docs/user_guide/model_repository.md). Depending on
159+
the type of the model and on what Triton capabilities you want to enable for
160+
the model, you may need to create a [model
161+
configuration](docs/user_guide/model_configuration.md) for the model.
162+
163+
- [Add custom operations to Triton if needed by your model](docs/user_guide/custom_operations.md)
164+
- Enable model pipelining with [Model Ensemble](docs/user_guide/architecture.md#ensemble-models)
165+
and [Business Logic Scripting (BLS)](https://github.com/triton-inference-server/python_backend#business-logic-scripting)
166+
- Optimize your models setting [scheduling and batching](docs/user_guide/architecture.md#models-and-schedulers)
167+
parameters and [model instances](docs/user_guide/model_configuration.md#instance-groups).
168+
- Use the [Model Analyzer tool](https://github.com/triton-inference-server/model_analyzer)
169+
to help optimize your model configuration with profiling
170+
- Learn how to [explicitly manage what models are available by loading and
171+
unloading models](docs/user_guide/model_management.md)
172+
173+
#### Configure and Use Triton Inference Server
174+
175+
- Read the [Quick Start Guide](docs/getting_started/quickstart.md) to run Triton Inference
176+
Server on both GPU and CPU
177+
- Triton supports multiple execution engines, called
178+
[backends](https://github.com/triton-inference-server/backend#where-can-i-find-all-the-backends-that-are-available-for-triton), including
179+
[TensorRT](https://github.com/triton-inference-server/tensorrt_backend),
180+
[TensorFlow](https://github.com/triton-inference-server/tensorflow_backend),
181+
[PyTorch](https://github.com/triton-inference-server/pytorch_backend),
182+
[ONNX](https://github.com/triton-inference-server/onnxruntime_backend),
183+
[OpenVINO](https://github.com/triton-inference-server/openvino_backend),
184+
[Python](https://github.com/triton-inference-server/python_backend), and more
185+
- Not all the above backends are supported on every platform supported by Triton.
186+
Look at the
187+
[Backend-Platform Support Matrix](https://github.com/triton-inference-server/backend/blob/main/docs/backend_platform_support_matrix.md)
188+
to learn which backends are supported on your target platform.
189+
- Learn how to [optimize performance](docs/user_guide/optimization.md) using the
190+
[Performance Analyzer](https://github.com/triton-inference-server/perf_analyzer/blob/main/README.md)
191+
and
192+
[Model Analyzer](https://github.com/triton-inference-server/model_analyzer)
193+
- Learn how to [manage loading and unloading models](docs/user_guide/model_management.md) in
194+
Triton
195+
- Send requests directly to Triton with the [HTTP/REST JSON-based
196+
or gRPC protocols](docs/customization_guide/inference_protocols.md#httprest-and-grpc-protocols)
197+
198+
#### Client Support and Examples
199+
200+
A Triton *client* application sends inference and other requests to Triton. The
201+
[Python and C++ client libraries](https://github.com/triton-inference-server/client)
202+
provide APIs to simplify this communication.
203+
204+
- Review client examples for [C++](https://github.com/triton-inference-server/client/blob/main/src/c%2B%2B/examples),
205+
[Python](https://github.com/triton-inference-server/client/blob/main/src/python/examples),
206+
and [Java](https://github.com/triton-inference-server/client/blob/main/src/java/src/main/java/triton/client/examples)
207+
- Configure [HTTP](https://github.com/triton-inference-server/client#http-options)
208+
and [gRPC](https://github.com/triton-inference-server/client#grpc-options)
209+
client options
210+
- Send input data (e.g. a jpeg image) directly to Triton in the [body of an HTTP
211+
request without any additional metadata](https://github.com/triton-inference-server/server/blob/main/docs/protocol/extension_binary_data.md#raw-binary-request)
212+
213+
### Extend Triton
214+
215+
[Triton Inference Server's architecture](docs/user_guide/architecture.md) is specifically
216+
designed for modularity and flexibility
217+
218+
- [Customize Triton Inference Server container](docs/customization_guide/compose.md) for your use case
219+
- [Create custom backends](https://github.com/triton-inference-server/backend)
220+
in either [C/C++](https://github.com/triton-inference-server/backend/blob/main/README.md#triton-backend-api)
221+
or [Python](https://github.com/triton-inference-server/python_backend)
222+
- Create [decoupled backends and models](docs/user_guide/decoupled_models.md) that can send
223+
multiple responses for a request or not send any responses for a request
224+
- Use a [Triton repository agent](docs/customization_guide/repository_agents.md) to add functionality
225+
that operates when a model is loaded and unloaded, such as authentication,
226+
decryption, or conversion
227+
- Deploy Triton on [Jetson and JetPack](docs/user_guide/jetson.md)
228+
- [Use Triton on AWS
229+
Inferentia](https://github.com/triton-inference-server/python_backend/tree/main/inferentia)
230+
231+
### Additional Documentation
232+
233+
- [FAQ](docs/user_guide/faq.md)
234+
- [User Guide](docs/README.md#user-guide)
235+
- [Customization Guide](docs/README.md#customization-guide)
236+
- [Release Notes](https://docs.nvidia.com/deeplearning/triton-inference-server/release-notes/index.html)
237+
- [GPU, Driver, and CUDA Support
238+
Matrix](https://docs.nvidia.com/deeplearning/dgx/support-matrix/index.html)
239+
240+
## Contributing
241+
242+
Contributions to Triton Inference Server are more than welcome. To
243+
contribute please review the [contribution
244+
guidelines](CONTRIBUTING.md). If you have a backend, client,
245+
example or similar contribution that is not modifying the core of
246+
Triton, then you should file a PR in the [contrib
247+
repo](https://github.com/triton-inference-server/contrib).
248+
249+
## Reporting problems, asking questions
250+
251+
We appreciate any feedback, questions or bug reporting regarding this project.
252+
When posting [issues in GitHub](https://github.com/triton-inference-server/server/issues),
253+
follow the process outlined in the [Stack Overflow document](https://stackoverflow.com/help/mcve).
254+
Ensure posted examples are:
255+
- minimal – use as little code as possible that still produces the
256+
same problem
257+
- complete – provide all parts needed to reproduce the problem. Check
258+
if you can strip external dependencies and still show the problem. The
259+
less time we spend on reproducing problems the more time we have to
260+
fix it
261+
- verifiable – test the code you're about to provide to make sure it
262+
reproduces the problem. Remove all other problems that are not
263+
related to your request/question.
264+
265+
For issues, please use the provided bug report and feature request templates.
266+
267+
For questions, we recommend posting in our community
268+
[GitHub Discussions.](https://github.com/triton-inference-server/server/discussions)
269+
270+
## For more information
271+
272+
Please refer to the [NVIDIA Developer Triton page](https://developer.nvidia.com/nvidia-triton-inference-server)
273+
for more information.

0 commit comments

Comments
 (0)