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

Support arbitrary model outputs #556

Closed
wants to merge 82 commits into from
Closed

Support arbitrary model outputs #556

wants to merge 82 commits into from

Conversation

mshuaibii
Copy link
Collaborator

@mshuaibii mshuaibii commented Aug 7, 2023

Part of #520. Provides support for arbitrary model head predictions by leveraging a model's node/edge embeddings.

Specifically:

  • The custom_head flag in the config controls whether we want the model to create the head or the model architecture was created specifically for that target. If False, the desired outputs are expected to be hard-coded as part of the model. This is mainly to support existing models energy/force predictions, without changing those underlying models.
  • If custom_head=True, for the model makes the respective prediction depending on whether it isn't an equivariant property (by defining irrep_dim) or a scalar/list of scalars (shape).
  • For equivariant properties, we preserve equivariance through a multiplication of messages and spherical harmonics of the edges (sum[m_st*Y^irrep_dim(r_st)]).

Task tracking:

  • Resolve failing test following OCP Trainer merge.
  • Invariant prediction
  • Equivariant predictions
    • scalar-edge multiplication (GemNet-OC)
    • eSCN spherical harmonics
  • Support for arbitrary head aggregation (add, mean, etc.)
  • Add unit tests for arbitrary outputs

Baselines

  • OC20-2M: GemNet-OC
    • Custom energy
    • Custom forces
    • Custom both
  • OC20-2M: EqV2
  • Displays: EqV2 DT prediction

@mshuaibii mshuaibii mentioned this pull request Aug 8, 2023
19 tasks
@lbluque lbluque mentioned this pull request Apr 5, 2024
@mshuaibii mshuaibii marked this pull request as draft April 9, 2024 19:26
@mshuaibii mshuaibii added enhancement New feature or request and removed stale labels Apr 9, 2024
@misko
Copy link
Collaborator

misko commented Jun 11, 2024

@wood-b @mshuaibii @janiceblue Is this PR ready to merge? or is there something still outstanding?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Are these changes relevant to arbitrary model support? I didnt see calculator mentioned elsewhere

Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably was an issue with merge conflicts, as OCPCalculator is in src/fairchem/core/__init__.py already, will remove

janiceblue and others added 3 commits June 17, 2024 22:43
…unami enumeration (#764)

* adding new notebook for using fairchem models with NEBs

* adding md tutorials

* blocking code cells that arent needed or take too long
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dont-close enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants