fix: fix various icclrun bugs and enhance its stability#35
Merged
Conversation
…which is applied to all the nodes if there's no node-specific overrides
- change the conditional logic in the generated `run_wrapper.sh` from platform-based to IP-based - fix the `install_dir` inconsistency between build phase and `run_wrapper.sh` env export - fix the handling of `~` appearance in path variables - change Path-like env merging from override-based to append-based strategy
…e the entires and usage - update the explanations about the behavior of `install_dir`, `common_user`, and `backend_env` - move the `nodes` section below all the global entries - add the global `cmake_flags` entry - add the `user` entry under `nodes` to illustrate how to specify a node-specific user
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the stability and behavior of
icclrun, ensures entries incluster.yamlsuch as environment variables and CMake flags are handled correctly, and cleans up obsolete scripts. It also updates thecluster.yamltemplate to clarify usage.Changes
icclrunStability and Environment Handlinginstall_dirbetween build and runtime;~in path variables;cmake_flagsincluster.yamlapplied to all nodes unless overridden.Refactor / Cleanup
scripts/run_wrapper.shsince it is no longer useful.Documentation Update
examples/cluster.yamltemplateinstall_dir,common_user, andbackend_env;cmake_flagsentry;Platform and Backend Affected
Platform
Backend
Performance Impact
N/A.
Known Issues & Future Work
cluster.yamldoes not support specifying custom port numbers. Each node is assumed to have passwordless SSH access (e.g., viassh <IP>) configured in.ssh/config. Port support may be added in future work.Test Results
Test Involved Platform
Test Involved Backend
NVIDIA + MetaX Heterogeneous Cluster:
all_gather.log
all_reduce.log
all_to_all.log
broadcast.log
gather.log
reduce.log
reduce_scatter.log
send_recv.log
Checklist
Title, Branch, and Commits
feat: …,fix(nccl): …).<type>/xxx-yyyy-zzzzwhere<type>matches the PR title's Conventional Commits type and words are joined with hyphens (seeCONTRIBUTING.md§Branches).CONTRIBUTING.md§Pull Requests).master— the branch is rebased cleanly on top of the currentmaster.fixup!/squash!/wipcommits remain.Scope and Design
CONTRIBUTING.md§Code/General).printf/std::cout/print(...)left behind, orTODOwithout an owner and issue link.General Code Hygiene
CONTRIBUTING.md§Code/General).CONTRIBUTING.md§Code/General).the `AllReduce` implementation) (CONTRIBUTING.md§Code/General).CONTRIBUTING.md§Code/General).CONTRIBUTING.md§Code/General; §Python).C++ Specific (if C++ files changed)
clang-format(version 16, per.github/workflows/clang-format.yml) has been run against all modified applicable files; the diff is clean.assertwith messages that include at least__FILE__,__LINE__, and__func__(CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).CONTRIBUTING.md§C++).Python Specific (if Python files changed)
ruff checkpasses cleanly on CI (see.github/workflows/ruff.yml).ruff format --checkpasses cleanly — if not, runruff formatand commit the result.CONTRIBUTING.md§Python).pytest.skipmessages without terminal period) are honored where applicable (CONTRIBUTING.md§Python).CONTRIBUTING.md§Python).if,for, and similar control-flow statements (CONTRIBUTING.md§Python).return, except when it directly follows a control-flow statement (CONTRIBUTING.md§Python).CONTRIBUTING.md§Python).Testing
Build, CI, and Tooling
CMakeLists.txtunderif(AUTO_DETECT_DEVICES)or toif(AUTO_DETECT_BACKENDS)if applicable.clang-format.yml,ruff.yml) are green locally (or expected to be green on CI).Documentation
README.md,CONTRIBUTING.md, or inline docs updated when behavior, build flags, or developer workflow changed.!orBREAKING CHANGE:footer.Security and Safety