Skip to content

Energy response#523

Open
viktorsvahn wants to merge 21 commits into
ddmms:mainfrom
viktorsvahn:energy_response
Open

Energy response#523
viktorsvahn wants to merge 21 commits into
ddmms:mainfrom
viktorsvahn:energy_response

Conversation

@viktorsvahn

@viktorsvahn viktorsvahn commented May 2, 2026

Copy link
Copy Markdown

Pre-review checklist for PR author

Summary

Energy response of linear organic molecules of varying chain length to an external electrical field.

Linked issue

#433

Progress

  • Calculations
  • Analysis
  • Application
  • Documentation

Testing

mace-mp-0b3
mace-polar-1-s

New decorators/callbacks

N/A

@ElliottKasoar ElliottKasoar added the new benchmark Proposals and suggestions for new benchmarks label May 5, 2026
Comment on lines +49 to +52
data_path = download_github_data(
filename="LINEAR_CARBON_wB97M-V.zip",
github_uri="https://github.com/viktorsvahn/teoroo_ML-PEG/raw/refs/heads/main/data/source",
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woudl you like us to uplaod this to the s3 bucket or are you happy with this download?

Total MAE:
good: 0.01
bad: 5.0
unit: eV

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should these units be eV or kJ/mol?

bad: 5.0
unit: eV
tooltip: "Mean Absolute Error for all systems"
level_of_theory: wB97V-M

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this end in V not M? like stated in the calc file

_ = mol.get_potential_energy()

mol_name = str(mol.get_chemical_formula())
mol_dir = APP_ROOT / f"data/electric_field/energy_response/{model_name}"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should avoid writing directory to the app data in the calc script. usually we do this in the analysis step which does often duplicate files, but keeps everything modular

@joehart2001

Copy link
Copy Markdown
Collaborator

Hi @viktorsvahn thanks for the PR, looking really nice so far!

a few initial points:

  • would it be worth adding dispersion corrections for models trained on non-dispersion corrected functionals? we do this in other benchmarks when relevent e.g. the reference data contains dispersion corrections. see here
  • i know htis is a shorter benchmark but it would be good to have a tqdm progress bar
  • do we need both the analysis scripts?
  • i see what youve done with the metrics.yml, but i think we should write it out in full for consistency
  • is app_scaling_pol.py used?
  • would you be able to restore docs/source/tutorials/python/adding_benchmark.ipynb and models.yml? this will fix the conflicts + we won't need these edits in the production code
  • rebase for latest changes which may effect some imports

@ElliottKasoar

Copy link
Copy Markdown
Collaborator

Hi @viktorsvahn, just wanted to check in and see if there's anything we can do to help?

In addition to the above comments, please can you take a look at our new filtering guidelines: https://ddmms.github.io/ml-peg/developer_guide/filter.html

The principles are relatively simple, but you do have to be a little careful, so again, if anything is unclear, please do ask!

(You'll need to rebase to test this)

@viktorsvahn

Copy link
Copy Markdown
Author

Sorry for taking so long. I am currently on it and I will look at the new guidelines as well!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new benchmark Proposals and suggestions for new benchmarks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants