Update benchmark.py-- Enhance Benchmarking with Multi-Commit Support …
Author: SajanGhimire1
Pull request: yes

1. **Enhanced Metrics Handling**:
   - Integrated new metrics to capture detailed performance data: - `decode.latency.mean`: Captures the average latency during the decoding process. - `per_token.latency.mean`: Measures the average latency per token. - `per_token.throughput.value`: Calculates the throughput per token.
   - These metrics offer finer granularity of performance insights, aiding in the precise identification of bottlenecks and optimization opportunities.

2. **Support Multi-Commit Benchmarking**:
   - Implemented functionality to benchmark multiple commits by checking out specific commits and running benchmarks for each.
   - This feature allows users to compare the performance of different code versions, providing insights into how changes impact performance over time.
   - Utilized a context manager (`checkout_commit`) to manage the process of checking out and reverting commits.

3. **Providing Structured JSON Reports**:
   - Added functionality to generate and summarize benchmark results into structured JSON reports for better analysis and comparison.
   - The JSON reports include model, commit, configuration, and metrics data, facilitating detailed performance tracking and reporting.

4. ** Code Changes**:
   - Added `summarize` function to produce summaries of benchmark results.
   - Implemented `combine_summaries` function to aggregate information across commits.
   - Integrated these functions into the main script, ensuring comprehensive reporting and analysis.

These enhancements collectively improve the usability and effectiveness of the benchmarking process, making it easier to track and optimize performance across different code versions.

# What does this PR do?

<!--
Congratulations! You've made it this far! You're not quite done yet though.

Once merged, your PR is going to appear in the release notes with the title you set, so make sure it's a great title that fully reflects the extent of your awesome contribution.

Then, please replace this with a description of the change and which issue is fixed (if applicable). Please also include relevant motivation and context. List any dependencies (if any) that are required for this change.

Once you're done, someone will review your PR shortly (see the section "Who can review?" below to tag some potential reviewers). They may suggest changes to make the code even better. If no one reviewed your PR after a week has passed, don't hesitate to post a new comment @-mentioning the same persons---sometimes notifications get lost.
-->

<!-- Remove if not applicable -->

Fixes # (issue)


## Before submitting
- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
- [ ] Did you read the [contributor guideline](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md#create-a-pull-request),
      Pull Request section?
- [ ] Was this discussed/approved via a Github issue or the [forum](https://discuss.huggingface.co/)? Please add a link
      to it if that's the case.
- [ ] Did you make sure to update the documentation with your changes? Here are the
      [documentation guidelines](https://github.com/huggingface/transformers/tree/main/docs), and
      [here are tips on formatting docstrings](https://github.com/huggingface/transformers/tree/main/docs#writing-source-documentation).
- [ ] Did you write any new necessary tests?


## Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

<!-- Your PR will be replied to more quickly if you can figure out the right person to tag with @

 If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**.
 Please tag fewer than 3 people.

Models:

- text models: @ArthurZucker
- vision models: @amyeroberts
- speech models: @sanchit-gandhi
- graph models: @clefourrier

Library:

- flax: @sanchit-gandhi
- generate: @zucchini-nlp (visual-language models) or @gante (all others)
- pipelines: @Narsil
- tensorflow: @gante and @Rocketknight1
- tokenizers: @ArthurZucker
- trainer: @muellerzr and @SunMarc

Integrations:

- deepspeed: HF Trainer/Accelerate: @muellerzr
- ray/raytune: @richardliaw, @amogkam
- Big Model Inference: @SunMarc
- quantization (bitsandbytes, autogpt): @SunMarc

Documentation: @stevhliu

HF projects:

- accelerate: [different repo](https://github.com/huggingface/accelerate)
- datasets: [different repo](https://github.com/huggingface/datasets)
- diffusers: [different repo](https://github.com/huggingface/diffusers)
- rust tokenizers: [different repo](https://github.com/huggingface/tokenizers)

Maintained examples (not research project or legacy):

- Flax: @sanchit-gandhi
- PyTorch: See Models above and tag the person corresponding to the modality of the example.
- TensorFlow: @Rocketknight1

 -->


Comments:
Hi @54J4N, as per #31692, the different changes to the script should be split into separate PRs c.f. [my previous comment](https://github.com/huggingface/transformers/pull/31692#issuecomment-2237536348)

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the [contributing guidelines](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md) are likely to be ignored.