guidellm.benchmark.aggregator
BenchmarkAggregator
Bases: ABC
, StandardBaseModel
, Generic[BenchmarkT, RequestT, ResponseT]
A pydantic base class representing the base class for aggregating benchmark results. The purpose is to receive and process results from a Benchmarker as it iterates through a Scheduler for an individual benchmark run. As results are added, lightweight statistics are updated and stored for immediate progress and informational updates to the caller. Once the benchmark run is complete, the compile
method is called to finalize the benchmark and return a Benchmark object with all the results and statistics fully calculated.
Source code in src/guidellm/benchmark/aggregator.py
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
|
add_result(result)
Add a result to the aggregator. This will update the internal statistics and add the result to the list of results if it is not within the warmup or cooldown period.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result | SchedulerRequestResult[RequestT, ResponseT] | The result to add to the aggregator. | required |
Returns:
Type | Description |
---|---|
bool | True if the result was added, False if it was added because it did not fit within the warmup or cooldown period, was not requested, or is not finished |
Source code in src/guidellm/benchmark/aggregator.py
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
|
compile()
abstractmethod
Compile the benchmark results and statistics into a Benchmark object. This is required to be implemented by subclasses to finalize the benchmark and return the compiled object.
Source code in src/guidellm/benchmark/aggregator.py
GenerativeBenchmarkAggregator
Bases: BenchmarkAggregator[GenerativeBenchmark, GenerationRequest, ResponseSummary]
Source code in src/guidellm/benchmark/aggregator.py
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 |
|
add_result(result)
Add a result to the aggregator. This will update the internal statistics and add the result to the list of results if it is not within the warmup or cooldown period.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result | SchedulerRequestResult[GenerationRequest, ResponseSummary] | The result to add to the aggregator. | required |
Source code in src/guidellm/benchmark/aggregator.py
compile()
Compile the benchmark results and statistics into a GenerativeBenchmark object. This is required to be implemented by subclasses to finalize the benchmark and return the compiled object.
Source code in src/guidellm/benchmark/aggregator.py
GenerativeRequestsRunningStats
Bases: RequestsRunningStats
The metrics for generative requests that have succeeded, been canceled, or errored stored as running statistics for easy calculations of rates, averages, totals, etc.
Source code in src/guidellm/benchmark/aggregator.py
RequestsRunningStats
Bases: StandardBaseModel
The metrics for requests that have succeeded, been canceled, or errored stored as running statistics for easy calculations of rates, averages, totals, etc.
Source code in src/guidellm/benchmark/aggregator.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
|
SchedulerRunningStats
Bases: StandardBaseModel
The metrics for the scheduler stored as running statistics for easy calculations of rates, averages, totals, etc.