Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 7221c23

Browse files
committed
benchmark automation mention
1 parent fe75719 commit 7221c23

File tree

4 files changed

+11
-5
lines changed

4 files changed

+11
-5
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ If you are interested in contributing to TorchServe, your contributions will fal
2727
```
2828
- Run Regression test `python test/regression_tests.py`
2929
- For running individual test suites refer [code_coverage](docs/code_coverage.md) documentation
30+
- If you are updating an existing model make sure that performance hasn't degraded by running [benchmarks](https://github.com/pytorch/serve/tree/master/benchmarks) on the master branch and your branch and verify there is no performance regression
31+
- For large changes make sure to run the [automated benchmark suite](https://github.com/pytorch/serve/tree/master/test/benchmark) which will run the apache bench tests on several configurations of CUDA and EC2 instances
3032
- If you need more context on a particular issue, please create raise a ticket on [`TorchServe` GH repo](https://github.com/pytorch/serve/issues/new/choose) or connect to [PyTorch's slack channel](https://pytorch.slack.com/)
3133

3234
Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/pytorch/serve. Use this [template](pull_request_template.md) when creating a Pull Request.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ TorchServe is a flexible and easy to use tool for serving PyTorch models.
4848

4949
Refer to the documentation [here](docs/torchserve_on_win_native.md).
5050

51-
2. Install torchserve and torch-model-archiver
51+
2. Install torchserve, torch-model-archiver and torch-workflow-archiver
5252

5353
For [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install)
5454
Note: Conda packages are not supported for Windows. Refer to the documentation [here](docs/torchserve_on_win_native.md).
5555
```
56-
conda install torchserve torch-model-archiver -c pytorch
56+
conda install torchserve torch-model-archiver torch-workflow-archiver -c pytorch
5757
```
5858

5959
For Pip
6060
```
61-
pip install torchserve torch-model-archiver
61+
pip install torchserve torch-model-archiver torch-workflow-archiver
6262
```
6363

6464
Now you are ready to [package and serve models with TorchServe](#serve-a-model).
@@ -71,7 +71,7 @@ Ensure that you have `python3` installed, and the user has access to the site-pa
7171

7272
Run the following script from the top of the source directory.
7373

74-
NOTE: This script uninstalls existing `torchserve` and `torch-model-archiver` installations
74+
NOTE: This script uninstalls existing `torchserve`, `torch-model-archiver` and `torch-workflow-archiver` installations
7575

7676
#### For Debian Based Systems/ MacOS
7777

benchmarks/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ We currently support benchmarking with JMeter & Apache Bench. One can also profi
66

77
* [Benchmarking with JMeter](#benchmarking-with-jmeter)
88
* [Benchmarking with Apache Bench](#benchmarking-with-apache-bench)
9+
* [AutoBenchmarking Apachage Bench on AWS](#benchmarking-apache-bench-aws)
910
* [Profiling](#profiling)
1011

1112
# Benchmarking with JMeter
@@ -315,6 +316,9 @@ The reports are generated at location "/tmp/benchmark/"
315316
### Sample latency graph
316317
![](predict_latency.png)
317318

319+
# Benchmarking-apache-bench-aws
320+
If you're making a large change to TorchServe it's best to run an [automated benchmarking suite on AWS](https://github.com/pytorch/serve/tree/master/test/benchmark) so that you can test multiple CUDA versions and EC2 hardware configurations easily.
321+
318322
# Profiling
319323

320324
## Frontend

binaries/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
```pwsh
1010
python .\ts_scripts\install_dependencies.py --environment=dev
1111
```
12-
> For GPU with Cuda 10.1, make sure add the `--cuda cu101` arg to the above command
12+
> For GPU with Cuda 10.2, make sure add the `--cuda cu102` arg to the above command
1313
1414

1515
2. To build a `torchserve` and `torch-model-archiver` wheel execute:

0 commit comments

Comments
 (0)