Skip to content

Update CLI args format for NIXL bench#823

Merged
amaslenn merged 2 commits intomainfrom
am/nixl-bench-cli
Mar 5, 2026
Merged

Update CLI args format for NIXL bench#823
amaslenn merged 2 commits intomainfrom
am/nixl-bench-cli

Conversation

@amaslenn
Copy link
Contributor

@amaslenn amaslenn commented Mar 4, 2026

Summary

Update CLI args format for NIXL bench.

Fixes internal bug.

Test Plan

  1. CI
  2. Tested by Verification team (thanks @Bohatchuk!).

Additional Notes

@amaslenn amaslenn changed the title Am/nixl bench cli Update CLI args format for NIXL bench. Mar 4, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6e09ab12-f829-4fa8-8ba5-6f269ce497b2

📥 Commits

Reviewing files that changed from the base of the PR and between 2087843 and 8ea29b4.

📒 Files selected for processing (3)
  • src/cloudai/workloads/nixl_bench/slurm_command_gen_strategy.py
  • tests/ref_data/nixl_bench.sbatch
  • tests/workloads/nixl_bench/test_command_gen_strategy_slurm.py

📝 Walkthrough

Walkthrough

The changes standardize command-line argument formatting in the NIXLBench workload from space-separated style (--key value) to equals-sign style (--key=value) across the command generation strategy, test reference data, and test assertions.

Changes

Cohort / File(s) Summary
NIXLBench Argument Formatting
src/cloudai/workloads/nixl_bench/slurm_command_gen_strategy.py
Modified argument construction in gen_nixlbench_command to use --{k}={v} format instead of --{k} {v} for CLI flags.
Test Updates
tests/ref_data/nixl_bench.sbatch, tests/workloads/nixl_bench/test_command_gen_strategy_slurm.py
Updated reference SLURM batch script and test assertions to expect equals-sign formatted arguments (--etcd-endpoints=..., --backend=..., etc.) matching the new implementation style.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 With equal signs so neat and clean,
The arguments now standardized keen!
No spaces dancing here and there,
Just dashes, equals—format fair!
This NIXLBench hop is spaced just right,
A tidy command takes flight! 🚀

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: updating CLI arguments format for NIXL bench, which matches the changeset modifications across all three files.
Description check ✅ Passed The description is directly related to the changeset, explaining the CLI args format update for NIXL bench and referencing the bug fix being addressed.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch am/nixl-bench-cli

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


Comment @coderabbitai help to get the list of available commands and usage tips.

@amaslenn amaslenn changed the title Update CLI args format for NIXL bench. Update CLI args format for NIXL bench Mar 4, 2026
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 4, 2026

Greptile Summary

This PR fixes the CLI argument format used when invoking the nixlbench binary, switching from space-separated style to equals-sign-separated style. The fix is applied in gen_nixlbench_command inside NIXLBenchSlurmCommandGenStrategy, and all downstream artifacts (reference sbatch file and unit tests) are updated in sync.

  • Core fix (slurm_command_gen_strategy.py): Single-line change in gen_nixlbench_command adopts the equals-sign style, which is the format required by the binary.
  • Reference data (tests/ref_data/nixl_bench.sbatch): Both srun invocations updated to reflect the corrected argument style.
  • Tests (tests/workloads/nixl_bench/test_command_gen_strategy_slurm.py): Assertions in test_default and test_can_set_any_cmd_arg updated to expect the new format.
  • A source-wide grep confirmed no other locations use the old space-separated format for this command, so the change is complete.

Confidence Score: 5/5

  • This PR is safe to merge — it is a minimal, targeted bug fix with complete test coverage and no risk of regressions.
  • The change is a single-line fix in one code path, the old format has been completely eliminated from the source tree, and all three affected artifacts (source, reference data, tests) are updated consistently. No unrelated files were touched and no logic was restructured.
  • No files require special attention.

Important Files Changed

Filename Overview
tests/ref_data/nixl_bench.sbatch Reference sbatch file updated to reflect the new =-separated argument format (--etcd-endpoints=... and --backend=...); consistent with the source change.
src/cloudai/workloads/nixl_bench/slurm_command_gen_strategy.py Single-line fix changing CLI argument format from space-separated to equals-sign-separated in gen_nixlbench_command; minimal and correct.
tests/workloads/nixl_bench/test_command_gen_strategy_slurm.py Assertions updated in test_default and test_can_set_any_cmd_arg to match the new equals-sign argument format; all affected tests are covered.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[gen_nixlbench_command] --> B{iterate cmd_args_dict keys}
    B --> C{key is etcd_endpoints?}
    C -- Yes --> D[rename to etcd-endpoints]
    C -- No --> E[keep key unchanged]
    D --> F[append arg with equals-sign format]
    E --> F
    F --> G[return command list]
    G --> H[gen_nixlbench_srun_commands]
    H --> I[srun launches nixlbench with corrected arg format]
Loading

Last reviewed commit: 8ea29b4

@amaslenn amaslenn requested a review from podkidyshev March 4, 2026 15:16
@amaslenn amaslenn merged commit 8749d43 into main Mar 5, 2026
5 checks passed
@amaslenn amaslenn deleted the am/nixl-bench-cli branch March 5, 2026 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants