feat: add bond length distribution benchmark#666
Draft
lwalew wants to merge 1 commit into
Draft
Conversation
Migrate the bond length distribution benchmark from the MLIP Audit suite. An NVT molecular dynamics simulation is run for each of a set of small organic molecules, and the deviation of a tracked covalent bond from its QM-optimised reference length is measured over the trajectory. Lower average deviation is better. Adds the calculation, analysis (histogram of deviations plus a metrics table), Dash app, documentation, and the mlipaudit dependency wiring (optional extra, git source and MLIP Audit framework badge).
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.
Pre-review checklist for PR author
PR author must check the checkboxes below when creating the PR.
Summary
Migrates the bond length distribution benchmark from the MLIP Audit suite. For each of a set of small organic molecules — covering the C-C, C=C, C#C, C-N, C-O, C=O and C-F bond types — an NVT molecular dynamics simulation is run at 300 K starting from a QM-optimised reference geometry (selected from QM9), and the deviation of a tracked covalent bond from its reference length is measured over the trajectory. A well behaved potential keeps bonds close to their reference length, so a lower average deviation is better.
The analysis reports the average bond length deviation per model in the metrics table and shows the distribution of sampled deviations as a histogram.
Linked issue
Resolves #665
Progress
Testing
Not yet run end-to-end: the benchmark input data still needs to be uploaded to the ML-PEG S3 bucket at
inputs/molecular_dynamics/bond_length_distribution/bond_length_distribution.zip(layoutbond_length_distribution/bond_length_distribution.json). Kept as a draft until the data is available. Style checks (pre-commit) pass locally.New decorators/callbacks
No new callbacks required; uses the existing
plot_histandbuild_tabledecorators and theplot_from_table_columncallback.Note for reviewers
This is the first MLIP Audit migration, so it also adds the shared mlipaudit wiring: the
mlipauditoptional extra and git source inpyproject.toml, themlip_auditframework badge inframeworks.yml, andml_peg/calcs/utils/mlipaudit.py. This overlaps with the other in-flight MLIP Audit migration PRs (e.g. #660, #644); whichever lands first introduces this wiring and the others can drop it.