Skip to content

Commit 2ec9299

Browse files
authored
Update README and add RELEASE notes for 23.05 (#696)
1 parent 3193047 commit 2ec9299

File tree

1 file changed

+90
-3
lines changed

1 file changed

+90
-3
lines changed

README.md

Lines changed: 90 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,93 @@ limitations under the License.
1818

1919
# Triton Model Analyzer
2020

21-
**Note** <br>
22-
You are currently on the r23.05 branch which tracks stabilization towards the next release.<br>
23-
This branch is not usable during stabilization.
21+
**LATEST RELEASE: You are currently on the main branch which tracks
22+
under-development progress towards the next release. The latest
23+
release of the Triton Model Analyzer is 1.28.0 and is available on
24+
branch
25+
[r23.05](https://github.com/triton-inference-server/model_analyzer/tree/r23.05).**
26+
27+
Triton Model Analyzer is a CLI tool which can help you find a more optimal configuration, on a given piece of hardware, for single, multiple, ensemble, or BLS models running on a [Triton Inference Server](https://github.com/triton-inference-server/server/). Model Analyzer will also generate reports to help you better understand the trade-offs of the different configurations along with their compute and memory requirements.
28+
<br><br>
29+
30+
# Features
31+
32+
### Search Modes
33+
34+
- [Quick Search](docs/config_search.md#quick-search-mode) will **sparsely** search the [Max Batch Size](https://github.com/triton-inference-server/server/blob/main/docs/user_guide/model_configuration.md#maximum-batch-size),
35+
[Dynamic Batching](https://github.com/triton-inference-server/server/blob/main/docs/user_guide/model_configuration.md#dynamic-batcher), and
36+
[Instance Group](https://github.com/triton-inference-server/server/blob/main/docs/user_guide/model_configuration.md#instance-groups) spaces by utilizing a heuristic hill-climbing algorithm to help you quickly find a more optimal configuration
37+
38+
- [Automatic Brute Search](docs/config_search.md#automatic-brute-search) will **exhaustively** search the
39+
[Max Batch Size](https://github.com/triton-inference-server/server/blob/main/docs/user_guide/model_configuration.md#maximum-batch-size),
40+
[Dynamic Batching](https://github.com/triton-inference-server/server/blob/main/docs/user_guide/model_configuration.md#dynamic-batcher), and
41+
[Instance Group](https://github.com/triton-inference-server/server/blob/main/docs/user_guide/model_configuration.md#instance-groups)
42+
parameters of your model configuration
43+
44+
- [Manual Brute Search](docs/config_search.md#manual-brute-search) allows you to create manual sweeps for every parameter that can be specified in the model configuration
45+
46+
### Model Types
47+
48+
- [Ensemble Model Search](docs/config_search.md#ensemble-model-search): Model Analyzer can help you find the optimal
49+
settings when profiling an ensemble model, utilizing the [Quick Search](docs/config_search.md#quick-search-mode) algorithm
50+
51+
- [BLS Model Search](docs/config_search.md#bls-model-search): Model Analyzer can help you find the optimal
52+
settings when profiling a BLS model, utilizing the [Quick Search](docs/config_search.md#quick-search-mode) algorithm
53+
54+
- [Multi-Model Search](docs/config_search.md#multi-model-search-mode): **EARLY ACCESS** - Model Analyzer can help you
55+
find the optimal settings when profiling multiple concurrent models, utilizing the [Quick Search](docs/config_search.md#quick-search-mode) algorithm
56+
57+
### Other Features
58+
59+
- [Detailed and summary reports](docs/report.md): Model Analyzer is able to generate
60+
summarized and detailed reports that can help you better understand the trade-offs
61+
between different model configurations that can be used for your model.
62+
63+
- [QoS Constraints](docs/config.md#constraint): Constraints can help you
64+
filter out the Model Analyzer results based on your QoS requirements. For
65+
example, you can specify a latency budget to filter out model configurations
66+
that do not satisfy the specified latency threshold.
67+
<br><br>
68+
69+
# Examples and Tutorials
70+
71+
### **Single Model**
72+
73+
See the [Single Model Quick Start](docs/quick_start.md) for a guide on how to use Model Analyzer to profile, analyze and report on a simple PyTorch model.
74+
75+
### **Multi Model**
76+
77+
See the [Multi-model Quick Start](docs/mm_quick_start.md) for a guide on how to use Model Analyzer to profile, analyze and report on two models running concurrently on the same GPU.
78+
<br><br>
79+
80+
# Documentation
81+
82+
- [Installation](docs/install.md)
83+
- [Model Analyzer CLI](docs/cli.md)
84+
- [Launch Modes](docs/launch_modes.md)
85+
- [Configuring Model Analyzer](docs/config.md)
86+
- [Model Analyzer Metrics](docs/metrics.md)
87+
- [Model Config Search](docs/config_search.md)
88+
- [Checkpointing](docs/checkpoints.md)
89+
- [Model Analyzer Reports](docs/report.md)
90+
- [Deployment with Kubernetes](docs/kubernetes_deploy.md)
91+
<br><br>
92+
93+
# Reporting problems, asking questions
94+
95+
We appreciate any feedback, questions or bug reporting regarding this
96+
project. When help with code is needed, follow the process outlined in
97+
the Stack Overflow (https://stackoverflow.com/help/mcve)
98+
document. Ensure posted examples are:
99+
100+
- minimal – use as little code as possible that still produces the
101+
same problem
102+
103+
- complete – provide all parts needed to reproduce the problem. Check
104+
if you can strip external dependency and still show the problem. The
105+
less time we spend on reproducing problems the more time we have to
106+
fix it
107+
108+
- verifiable – test the code you're about to provide to make sure it
109+
reproduces the problem. Remove all other problems that are not
110+
related to your request/question.

0 commit comments

Comments
 (0)