Check all environment variables for Slurm environment#32799
Check all environment variables for Slurm environment#32799copybara-service[bot] merged 1 commit intojax-ml:mainfrom
Conversation
In some environments only the SLURM_JOB_ID might be set, e.g. when using hooks for SSH to a node with an existing allocation This causes a false positive in the detection and later `KeyError` on e.g. `SLURM_LOCALID`
Summary of ChangesHello @Flamefire, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the detection mechanism for Slurm environments to prevent erroneous identification when only a subset of Slurm-specific environment variables are present. By requiring the presence of all essential Slurm variables, the system avoids runtime errors that occur when attempting to access non-existent environment data, ensuring more robust and accurate cluster environment handling. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
The pull request modifies the is_env_present method in SlurmCluster to check for the presence of multiple environment variables instead of just SLURM_JOB_ID. This change aims to prevent false positives and subsequent KeyError exceptions when only SLURM_JOB_ID is set. I have added a review comment to address a potential issue.
| return all(var in os.environ for var in | ||
| (_JOBID_PARAM, _NODE_LIST, _PROCESS_COUNT, _PROCESS_ID, _LOCAL_PROCESS_ID)) |
There was a problem hiding this comment.
Checking for the existence of all these environment variables might be too strict. Consider whether the application can gracefully handle the absence of some of these variables, or provide a mechanism to configure which variables are required. If some variables are optional, the all() check should be adjusted accordingly to avoid preventing the cluster from being detected when it could still function.
For example, if _NODE_LIST is sometimes optional, you might want to remove it from the all() check, or have a separate check for it.
| return all(var in os.environ for var in | |
| (_JOBID_PARAM, _NODE_LIST, _PROCESS_COUNT, _PROCESS_ID, _LOCAL_PROCESS_ID)) | |
| return _JOBID_PARAM in os.environ and all( | |
| var in os.environ for var in (_NODE_LIST, _PROCESS_COUNT, _PROCESS_ID, _LOCAL_PROCESS_ID) | |
| ) |
In some environments only the SLURM_JOB_ID might be set, e.g. when using hooks for SSH to a node with an existing allocation
This causes a false positive in the detection and later
KeyErroron e.g.SLURM_LOCALID