self energy and e3 model fix#52
Open
Lonya0 wants to merge 2 commits into
Open
Conversation
📝 WalkthroughWalkthroughThe PR enhances parallel self-energy computation by introducing configurable Joblib backends and safer temporary-file aggregation, propagates an ChangesParallel self-energy execution with override_overlap integration
Sequence DiagramsequenceDiagram
participant NEGF
participant prepare_self_energy
participant compute_all_self_energy
participant Parallel as Joblib (parallel_backend)
participant self_energy_worker
participant merge as HDF5 merge
NEGF->>prepare_self_energy: Invoke with parallel_options
prepare_self_energy->>compute_all_self_energy: Pass n_jobs, batch_size, parallel_backend
compute_all_self_energy->>compute_all_self_energy: Create temp_dir
compute_all_self_energy->>Parallel: Execute workers with backend
Parallel->>self_energy_worker: Run per (k, e) point
self_energy_worker->>self_energy_worker: Write shard HDF5 to temp_dir
compute_all_self_energy->>merge: Aggregate shards
merge->>merge: Finalize leadL.h5 / leadR.h5
compute_all_self_energy->>compute_all_self_energy: Remove temp_dir
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
dpnegf/utils/elec_struc_cal.py (1)
153-172:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse a context manager for
h5py.Fileto avoid leaked handles on exceptions.Line 153 opens the file and Line 172 closes it manually; any exception in between can skip close.
Suggested fix
- overlap_blocks = h5py.File(override_overlap, "r") - if len(overlap_blocks) != 1: - log.info('Overlap file contains more than one overlap matrix, only first will be used.') - if self.overlap: - log.warning('override_overlap is enabled while model contains overlap, override_overlap will be used.') - if "0" in overlap_blocks: - overlaps = overlap_blocks["0"] - else: - overlaps = overlap_blocks["1"] - block_to_feature(data, self.model.idp, blocks=False, overlap_blocks=overlaps) - if not self.overlap: - self.eigv = Eigenvalues( - idp=self.model.idp, - device=self.device, - s_edge_field=AtomicDataDict.EDGE_OVERLAP_KEY, - s_node_field=AtomicDataDict.NODE_OVERLAP_KEY, - s_out_field=AtomicDataDict.OVERLAP_KEY, - dtype=self.model.dtype, - ) - overlap_blocks.close() + with h5py.File(override_overlap, "r") as overlap_blocks: + if len(overlap_blocks) != 1: + log.info('Overlap file contains more than one overlap matrix, only first will be used.') + if self.overlap: + log.warning('override_overlap is enabled while model contains overlap, override_overlap will be used.') + overlaps = overlap_blocks["0"] if "0" in overlap_blocks else overlap_blocks["1"] + block_to_feature(data, self.model.idp, blocks=False, overlap_blocks=overlaps) + if not self.overlap: + self.eigv = Eigenvalues( + idp=self.model.idp, + device=self.device, + s_edge_field=AtomicDataDict.EDGE_OVERLAP_KEY, + s_node_field=AtomicDataDict.NODE_OVERLAP_KEY, + s_out_field=AtomicDataDict.OVERLAP_KEY, + dtype=self.model.dtype, + )🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@dpnegf/utils/elec_struc_cal.py` around lines 153 - 172, The code opens an h5py.File into overlap_blocks and closes it manually, risking leaked file handles on exceptions; wrap the open in a context manager (with h5py.File(override_overlap, "r") as overlap_blocks:) and move the logic that reads overlap_blocks (the log/info checks, the "0"/"1" selection, call to block_to_feature(... overlap_blocks=overlaps) and the conditional creation of Eigenvalues) inside that with-block, then remove the explicit overlap_blocks.close() call; keep existing references to override_overlap, overlaps, block_to_feature, self.overlap, and the Eigenvalues constructor unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@dpnegf/runner/NEGF.py`:
- Around line 125-129: The default parallel_options dict uses the wrong key
"n_job" which causes KeyError when code later accesses
self.parallel_options["n_jobs"]; update the default to use the correct key name
"n_jobs" (i.e., set "n_jobs": -1) or alternatively change the later accesses to
read "n_job" consistently, but prefer changing the default so
self.parallel_options and all reads use "n_jobs"; ensure any other keys (e.g.,
"batch_size", "backend") remain unchanged.
- Around line 113-115: The validation currently asserts override_overlap is a
str which rejects the valid False boolean; update the check in the __init__ (or
where override_overlap is read) so it accepts either False or a str (e.g. use
isinstance(kwargs['override_overlap'], (str, bool)) or explicitly allow
kwargs['override_overlap'] is False), then assign self.override_overlap =
kwargs['override_overlap'] unchanged; reference the override_overlap handling
around the current assert and self.override_overlap assignment.
In `@dpnegf/tests/test_negf_e3.py`:
- Around line 36-37: Replace the shell-based cleanup call that uses
os.system("rm -r "+output+"/results") with a platform-safe Python removal:
import shutil if not already imported, and call
shutil.rmtree(os.path.join(output, "results")) (optionally wrapped in a
try/except or check with os.path.exists) instead of os.system; update the block
around the existing os.path.exists(output+"/results") check and remove the
os.system usage to ensure safe, cross-platform test cleanup.
In `@dpnegf/utils/argcheck.py`:
- Line 1070: The schema for Argument("override_overlap", str, optional=True,
doc=doc_override_overlap) currently only accepts str and thus blocks the
explicit disable path; update the Argument type to accept both strings and
boolean False (e.g., allow (str, bool) or an equivalent union that permits
False) so callers can pass False to disable overlap override, and ensure any
downstream validation logic that checks override_overlap handles the False
sentinel correctly while keeping doc_override_overlap unchanged.
---
Outside diff comments:
In `@dpnegf/utils/elec_struc_cal.py`:
- Around line 153-172: The code opens an h5py.File into overlap_blocks and
closes it manually, risking leaked file handles on exceptions; wrap the open in
a context manager (with h5py.File(override_overlap, "r") as overlap_blocks:) and
move the logic that reads overlap_blocks (the log/info checks, the "0"/"1"
selection, call to block_to_feature(... overlap_blocks=overlaps) and the
conditional creation of Eigenvalues) inside that with-block, then remove the
explicit overlap_blocks.close() call; keep existing references to
override_overlap, overlaps, block_to_feature, self.overlap, and the Eigenvalues
constructor unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9634520d-38e1-4c60-abe6-9674b91abc5f
📒 Files selected for processing (7)
dpnegf/negf/lead_property.pydpnegf/runner/NEGF.pydpnegf/tests/data/test_negf/test_negf_e3/7_0.vaspdpnegf/tests/data/test_negf/test_negf_e3/negf_7_0.jsondpnegf/tests/test_negf_e3.pydpnegf/utils/argcheck.pydpnegf/utils/elec_struc_cal.py
Comment on lines
+113
to
+115
| if 'override_overlap' in kwargs: | ||
| assert isinstance(kwargs['override_overlap'], str) | ||
| self.override_overlap = kwargs['override_overlap'] |
There was a problem hiding this comment.
override_overlap=False cannot pass through runner validation.
Line 114 asserts str, which rejects the explicit False disable behavior supported downstream.
Suggested fix
- if 'override_overlap' in kwargs:
- assert isinstance(kwargs['override_overlap'], str)
+ if 'override_overlap' in kwargs:
+ assert isinstance(kwargs['override_overlap'], (str, bool, type(None)))
self.override_overlap = kwargs['override_overlap']📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| if 'override_overlap' in kwargs: | |
| assert isinstance(kwargs['override_overlap'], str) | |
| self.override_overlap = kwargs['override_overlap'] | |
| if 'override_overlap' in kwargs: | |
| assert isinstance(kwargs['override_overlap'], (str, bool, type(None))) | |
| self.override_overlap = kwargs['override_overlap'] |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@dpnegf/runner/NEGF.py` around lines 113 - 115, The validation currently
asserts override_overlap is a str which rejects the valid False boolean; update
the check in the __init__ (or where override_overlap is read) so it accepts
either False or a str (e.g. use isinstance(kwargs['override_overlap'], (str,
bool)) or explicitly allow kwargs['override_overlap'] is False), then assign
self.override_overlap = kwargs['override_overlap'] unchanged; reference the
override_overlap handling around the current assert and self.override_overlap
assignment.
Comment on lines
+125
to
+129
| self.parallel_options = { | ||
| "n_job": -1, | ||
| "batch_size": 200, | ||
| "backend": "loky" | ||
| } |
There was a problem hiding this comment.
Default parallel options will crash with KeyError.
Line 126 defines n_job, but Lines 564 and 571 read n_jobs. If parallel_options is not provided, this path fails at runtime.
Suggested fix
else:
self.parallel_options = {
- "n_job": -1,
+ "n_jobs": -1,
"batch_size": 200,
"backend": "loky"
}Also applies to: 564-565, 571-572
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@dpnegf/runner/NEGF.py` around lines 125 - 129, The default parallel_options
dict uses the wrong key "n_job" which causes KeyError when code later accesses
self.parallel_options["n_jobs"]; update the default to use the correct key name
"n_jobs" (i.e., set "n_jobs": -1) or alternatively change the later accesses to
read "n_job" consistently, but prefer changing the default so
self.parallel_options and all reads use "n_jobs"; ensure any other keys (e.g.,
"batch_size", "backend") remain unchanged.
Comment on lines
+36
to
+37
| if os.path.exists(output+"/results"): | ||
| os.system("rm -r "+output+"/results") |
There was a problem hiding this comment.
Avoid shell-based cleanup in tests.
Line 37 uses os.system("rm -r ..."); prefer shutil.rmtree for safer, platform-independent cleanup.
Suggested fix
+import shutil
...
- if os.path.exists(output+"/results"):
- os.system("rm -r "+output+"/results")
+ if os.path.exists(output + "/results"):
+ shutil.rmtree(output + "/results")📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| if os.path.exists(output+"/results"): | |
| os.system("rm -r "+output+"/results") | |
| if os.path.exists(output + "/results"): | |
| shutil.rmtree(output + "/results") |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@dpnegf/tests/test_negf_e3.py` around lines 36 - 37, Replace the shell-based
cleanup call that uses os.system("rm -r "+output+"/results") with a
platform-safe Python removal: import shutil if not already imported, and call
shutil.rmtree(os.path.join(output, "results")) (optionally wrapped in a
try/except or check with os.path.exists) instead of os.system; update the block
around the existing os.path.exists(output+"/results") check and remove the
os.system usage to ensure safe, cross-platform test cleanup.
| Argument("out_ldos", bool, optional=True, default=False, doc=doc_out_ldos), | ||
| Argument("out_lcurrent", bool, optional=True, default=False, doc=doc_out_lcurrent) | ||
| Argument("out_lcurrent", bool, optional=True, default=False, doc=doc_out_lcurrent), | ||
| Argument("override_overlap", str, optional=True, doc=doc_override_overlap), |
There was a problem hiding this comment.
override_overlap schema blocks the explicit disable path.
Line 1070 only accepts str, but the downstream API supports False to explicitly disable overlap override. This prevents that behavior from being expressed in config.
Suggested fix
- Argument("override_overlap", str, optional=True, doc=doc_override_overlap),
+ Argument("override_overlap", [str, bool, None], optional=True, default=None, doc=doc_override_overlap),📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Argument("override_overlap", str, optional=True, doc=doc_override_overlap), | |
| Argument("override_overlap", [str, bool, None], optional=True, default=None, doc=doc_override_overlap), |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@dpnegf/utils/argcheck.py` at line 1070, The schema for
Argument("override_overlap", str, optional=True, doc=doc_override_overlap)
currently only accepts str and thus blocks the explicit disable path; update the
Argument type to accept both strings and boolean False (e.g., allow (str, bool)
or an equivalent union that permits False) so callers can pass False to disable
overlap override, and ensure any downstream validation logic that checks
override_overlap handles the False sentinel correctly while keeping
doc_override_overlap unchanged.
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
2 participants
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 by CodeRabbit
New Features
Tests