Skip to content

Move benchmarking workflow cli from testinfra to executorch #10162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Camyll
Copy link

@Camyll Camyll commented Apr 14, 2025

Request from Executorch team to run android-perf or apple-perf workflows via commandline

https://github.com/pytorch/executorch/actions/workflows/android-perf.yml
https://github.com/pytorch/executorch/actions/workflows/apple-perf.yml

HOW TO:

  1. Be in repo pytorch/executorch. Navigate to extension/benchmark folder.
  2. Make sure you have your GITHUB_TOKEN set (classic personal access token, not fine-grained) (export GITHUB_TOKEN=<YOUR_TOKEN>)
  3. run python benchmark_workflow_cli.py with either --android or --ios as a required argument
  4. use --help to see other optional arguments (--branch, --models, --devices, --benchmark-configs)

cc @guangy10 @huydhn @kirklandsign @shoumikhin

@Camyll Camyll requested a review from tarun292 as a code owner April 14, 2025 21:51
Copy link

pytorch-bot bot commented Apr 14, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/10162

Note: Links to docs will display an error until the docs builds have been completed.

❌ 4 New Failures, 24 Unrelated Failures

As of commit cd6b6fe with merge base cb3eba0 (image):

NEW FAILURES - The following jobs have failed:

FLAKY - The following jobs failed but were likely due to flakiness present on trunk:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 14, 2025
Copy link

This PR needs a release notes: label

If your changes are user facing and intended to be a part of release notes, please use a label starting with release notes:.

If not, please add the topic: not user facing label.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "topic: not user facing"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

"--models",
type=str,
required=False,
default="llama",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to branch. Users should specify what model(s) they want to benchmark with. Do not provide default seems better to me

Comment on lines 30 to 42
app_type = parser.add_mutually_exclusive_group(required=True)
app_type.add_argument(
"--android",
action="store_true",
required=False,
help="run the test on Android",
)
app_type.add_argument(
"--ios",
action="store_true",
required=False,
help="run the test on iOS",
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: to be consistent, can we rename it to "platform"?

Copy link
Contributor

@guangy10 guangy10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not forget to include the instructions to the README.md

@Camyll Camyll added the module: benchmark Issues related to the benchmark infrastructure label Apr 21, 2025
@Camyll Camyll added the module: dev infra Issues related to developer infrastructure (other than CI, which is module: ci) label Apr 21, 2025
@Camyll Camyll requested a review from guangy10 April 22, 2025 18:00
@huydhn huydhn moved this to In Progress in ExecuTorch Benchmark Apr 25, 2025
@Camyll
Copy link
Author

Camyll commented May 21, 2025

@guangy10 can you remove changes requested as the PR has been updated? Thanks!

@huydhn
Copy link
Contributor

huydhn commented May 23, 2025

There are lots of unrelated failures, so you probably want to rebase it and also fix lint before landing (I could help with that)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. module: benchmark Issues related to the benchmark infrastructure module: dev infra Issues related to developer infrastructure (other than CI, which is module: ci) topic: not user facing
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

5 participants