Skip to content

fix: replace 'ianvs -f' with 'python benchmarking.py -f' in all example READMEs#579

Open
31groot wants to merge 1 commit into
kubeedge:mainfrom
31groot:fix/readme-ianvs-command
Open

fix: replace 'ianvs -f' with 'python benchmarking.py -f' in all example READMEs#579
31groot wants to merge 1 commit into
kubeedge:mainfrom
31groot:fix/readme-ianvs-command

Conversation

@31groot

@31groot 31groot commented Jul 5, 2026

Copy link
Copy Markdown

What type of PR is this?
/kind documentation

What this PR does / why we need it:
24 example READMEs instructed users to run ianvs -f which fails on
a fresh install with No module named ianvs. The correct command is
python benchmarking.py -f.

This is a systematic fix across all affected READMEs found via:
find examples -name "README.md" | xargs grep -l "ianvs -f"

Files changed: 24 READMEs, 34 occurrences replaced.

Which issue(s) this PR fixes:
Fixes #563

…le READMEs

Signed-off-by: Parv Agrawal <agrawalparv13@gmail.com>
@kubeedge-bot kubeedge-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 5, 2026
@kubeedge-bot kubeedge-bot requested a review from MooreZheng July 5, 2026 17:42
@kubeedge-bot

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: 31groot
To complete the pull request process, please assign jaypume after the PR has been reviewed.
You can assign the PR to them by writing /assign @jaypume in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubeedge-bot kubeedge-bot requested a review from Poorunga July 5, 2026 17:42
@kubeedge-bot kubeedge-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 5, 2026
@31groot

31groot commented Jul 5, 2026

Copy link
Copy Markdown
Author

/assign @jaypume

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates various README.md files across the repository to replace the ianvs CLI command with python benchmarking.py for running benchmarks. The review feedback highlights a few path issues, such as an incorrect absolute path in the cloud VLA finetune guide and an extra directory prefix in the LLM edge benchmark suite guide. Additionally, several code blocks containing shell commands are incorrectly marked with python syntax highlighting and should be updated to bash or shell.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

```
cd ianvs
ianvs -f /examples/cloud_VLA_finetune/singletask_learning_bench/benchmarkingjob.yaml
python benchmarking.py -f /examples/cloud_VLA_finetune/singletask_learning_bench/benchmarkingjob.yaml

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The path to the benchmarking job YAML file has a leading slash (/examples/...), which makes it an absolute path. Since the user just ran cd ianvs to enter the repository root, this should be a relative path (examples/...) so that the file can be correctly located relative to the current working directory.

Suggested change
python benchmarking.py -f /examples/cloud_VLA_finetune/singletask_learning_bench/benchmarkingjob.yaml
python benchmarking.py -f examples/cloud_VLA_finetune/singletask_learning_bench/benchmarkingjob.yaml


```bash
ianvs -f ianvs/examples/llm-edge-benchmark-suite/single_task_bench_with_compression/benchmarkingjob.yaml
python benchmarking.py -f ianvs/examples/llm-edge-benchmark-suite/single_task_bench_with_compression/benchmarkingjob.yaml

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The path contains an extra ianvs/ prefix (ianvs/examples/...). Since benchmarking.py is run from the root of the repository, the examples directory is directly accessible. Using ianvs/examples/... will result in a "file not found" error. Please use a relative path starting with examples/.

Suggested change
python benchmarking.py -f ianvs/examples/llm-edge-benchmark-suite/single_task_bench_with_compression/benchmarkingjob.yaml
python benchmarking.py -f examples/llm-edge-benchmark-suite/single_task_bench_with_compression/benchmarkingjob.yaml


```python
ianvs -f ./examples/MOT17/multiedge_inference_bench/pedestrian_tracking/tracking_job.yaml
python benchmarking.py -f ./examples/MOT17/multiedge_inference_bench/pedestrian_tracking/tracking_job.yaml

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The code block on line 49 is marked with python syntax highlighting, but the command inside is a shell/bash command. Please consider changing the language specifier on line 49 to bash or shell for correct syntax highlighting.


```python
ianvs -f ./examples/MOT17/multiedge_inference_bench/pedestrian_tracking/reid_job.yaml
python benchmarking.py -f ./examples/MOT17/multiedge_inference_bench/pedestrian_tracking/reid_job.yaml

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The code block on line 80 is marked with python syntax highlighting, but the command inside is a shell/bash command. Please consider changing the language specifier on line 80 to bash or shell for correct syntax highlighting.


```python
ianvs -f ./examples/imagenet/multiedge_inference_bench/classification_job_manual.yaml
python benchmarking.py -f ./examples/imagenet/multiedge_inference_bench/classification_job_manual.yaml

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The code block on line 46 is marked with python syntax highlighting, but the command inside is a shell/bash command. Please consider changing the language specifier on line 46 to bash or shell for correct syntax highlighting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Core setup failures on fresh install: API rename, missing class, wrong docs path, undocumented deps

3 participants