Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new base class: UnScaledPESModel #8

Merged
merged 9 commits into from
Jul 11, 2024
Merged

new base class: UnScaledPESModel #8

merged 9 commits into from
Jul 11, 2024

Conversation

jla-gardner
Copy link
Owner

@jla-gardner jla-gardner commented Jul 11, 2024

All GraphPESModels make generate total energy predictions as a sum over local contributions: $E = \sum_i \varepsilon_i$.

NN models tend to work best when they are trained to predict raw outputs that are unit-normally distributed: $y \sim \mathcal{N}(0, 1)$. It therefore "makes sense" to introduce this base class that guesses the variance in local energy contribution per element during pre-fitting, and then uses these (learnable) values to scale raw NN outputs to live on the same scale as the energies they are trying to predict.

Copy link

codecov bot commented Jul 11, 2024

Codecov Report

Attention: Patch coverage is 94.73684% with 4 lines in your changes missing coverage. Please review.

Project coverage is 88.00%. Comparing base (da7f627) to head (9792d46).

Files Patch % Lines
src/graph_pes/models/scaling.py 91.66% 3 Missing ⚠️
src/graph_pes/core.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main       #8      +/-   ##
==========================================
- Coverage   88.77%   88.00%   -0.78%     
==========================================
  Files          33       35       +2     
  Lines        1916     1968      +52     
==========================================
+ Hits         1701     1732      +31     
- Misses        215      236      +21     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jla-gardner jla-gardner changed the title create base class that automatically scales raw local energy predictions new base class: UnScaledPESModel Jul 11, 2024
@jla-gardner jla-gardner merged commit a89a2c2 into main Jul 11, 2024
0 of 4 checks passed
@jla-gardner jla-gardner deleted the auto-scaling branch July 11, 2024 09:42
@jla-gardner jla-gardner mentioned this pull request Jul 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant