Skip to content

Commit d5eb954

Browse files
Adding instruction for Tao bench mini and Feedsim mini (#309)
Summary: Pull Request resolved: #309 Adding instruction for running Feedsim mini and Taobench mini Reviewed By: charles-typ Differential Revision: D87388489 fbshipit-source-id: 1b29ba3df9c2825b0ff5121fa73de0ef128fefce
1 parent 7b0397c commit d5eb954

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

packages/feedsim/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,31 @@ If running on ARM platforms, please use the job `feedsim_autoscale_arm` (other u
6868
./benchpress_cli.py run feedsim_autoscale_arm
6969
```
7070

71+
### Running Feedsim Mini
72+
73+
Feedsim Mini is a shrunken version of Feedsim
74+
that aims to reduce execution time to a few seconds.
75+
It includes runtime breakdown tracking capabilities that record
76+
benchmark timestamps to enable metric filtering for the actual benchmark time,
77+
which is essential for mini jobs where execution time is only a few seconds.
78+
79+
To run Feedsim Mini, please follow these steps:
80+
81+
1. Make sure that you get the latest version of DCPerf and check out the latest commit in the `v2-beta` branch.
82+
If you've installed Feedsim with an older version of DCPerf,
83+
we recommend you clean and re-install Feedsim.
84+
85+
2. Run the `feedsim_autoscale_mini` job:
86+
87+
```bash
88+
./benchpress_cli.py run feedsim_autoscale_mini
89+
```
90+
91+
This mini job runs the same workload as the full Feedsim Autoscale but with
92+
minimal settings to enable quick testing and validation.
93+
A `breakdown.csv` file will be generated in the results to track runtime breakdowns,
94+
which can be used to filter metrics for the actual benchmark execution time.
95+
7196
## Reporting and Measurement
7297

7398
After the feedsim benchmark finishing, benchpress will report the results in

packages/tao_bench/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,31 @@ To start the clients and the server with autoscale on the same benchmarking mach
177177
```
178178
All the parameters used with autoscale can be used with standalone except interface_name.
179179

180+
### Running TaoBench Mini
181+
182+
TaoBench Standalone Mini is a shrunken version of TaoBench Standalone that
183+
aims to reduce execution time.
184+
It includes runtime breakdown tracking capabilities that record
185+
benchmark timestamps to enable metric filtering for the actual benchmark time,
186+
which is essential for mini jobs where execution time is only a few seconds.
187+
188+
To run TaoBench Standalone Mini, please follow these steps:
189+
190+
1. Make sure that you get the latest version of DCPerf and check out the latest commit in the `v2-beta` branch.
191+
If you've installed TaoBench with an older version of DCPerf,
192+
we recommend you clean and re-install TaoBench.
193+
194+
2. Run the `tao_bench_standalone_mini` job:
195+
196+
```bash
197+
./benchpress_cli.py run tao_bench_standalone_mini
198+
```
199+
200+
This mini job runs the same workload as the full TaoBench Standalone but with
201+
minimal settings to enable quick testing and validation.
202+
A `breakdown.csv` file will be generated in the results to track runtime breakdowns,
203+
which can be used to filter metrics for the actual benchmark execution time.
204+
180205
### Result reporting
181206

182207
Once the tao_bench benchmark finishes, benchpress will report the results in JSON format

0 commit comments

Comments
 (0)