Fix NequIP atom type mapping for deployed models - #85
Open
susumu-fujii wants to merge 1 commit into
Open
Conversation
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.
Fix NequIP atom type mapping for deployed models
Summary
This PR fixes the atom type mapping used by the NequIP solver during sampling.
Currently,
NequipSolver.Input.from_directory()reads the atom type order from:in
input.yaml.However, with NequIP 0.6.2, the atom type order used internally by the trained and deployed model is stored in
type_namesand may differ from the order ofchemical_symbols.For example, the training input may contain:
while the trained
config.yamlcontains:The deployed model metadata also contains:
Therefore, the deployed model expects:
but the current abICS implementation constructs the type indices from
chemical_symbolsand instead uses:As a result, Cu and V are evaluated using the wrong atom types, which can produce incorrect energies during sampling.
Fix
Use
type_namesandr_maxstored in the metadata ofdeployed.pthinstead of reconstructing the atom type mapping frominput.yaml["chemical_symbols"].This ensures that the atom type indices used by abICS are consistent with the mapping actually used by the deployed NequIP model.
Test
A regression test was added for the case where the order of
chemical_symbolsdiffers from the deployed model'stype_names.The test uses:
and mocked deployed-model metadata:
and verifies that
NequipSolver.Input.from_directory()uses:rather than the order in
chemical_symbols.The test fails with the previous implementation and passes with this fix.
Additional verification
The fix was also checked using an actual NequIP 0.6.2 deployed model.
After the change, the energy calculated through the abICS
NequipSolveragrees with the energy obtained directly usingNequIPCalculator.from_deployed_model()for the same structure.