feat(fennol): add FeNNol format support with MultiSystems capability for ML training data #878
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.
This PR implements support for the FeNNol format, enabling dpdata users to export both single
LabeledSystem
and multiple systems viaMultiSystems
to FeNNol's pickle format for machine learning training.Overview
FeNNol is a machine learning framework that requires data in a specific pickle format with training/validation splits. This implementation adds a new format plugin that converts dpdata systems to the required structure, with support for combining multiple different systems into a single training file.
Key Features
fennol
format to dpdata's format registrysystem.to("fennol", "output.pkl")
for anyLabeledSystem
multi_systems.to("fennol", "output.pkl")
to combine different systems into the same filespecies
: List of atomic species/elementscoordinates
: Atomic positions in Åformation_energy
: Energy in kcal/molshifted_energy
: Energy in kcal/mol (same as formation_energy)forces
: Atomic forces in kcal/mol/Åsystem_name
: Name of the originating system (for MultiSystems tracking)Unit Conversions
The plugin automatically handles unit conversions to match FeNNol's expected units:
Usage Examples
Testing
Comprehensive test suite includes:
All tests pass and the implementation follows project linting standards.
Fixes #876.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.