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

Add more MLPs: ALIGN-FF, NequIP, GAP, DP, and FLARE #1940

Open
Andrew-S-Rosen opened this issue Mar 25, 2024 · 4 comments
Open

Add more MLPs: ALIGN-FF, NequIP, GAP, DP, and FLARE #1940

Andrew-S-Rosen opened this issue Mar 25, 2024 · 4 comments
Labels
enhancement New feature or request good-first-issue

Comments

@Andrew-S-Rosen
Copy link
Member

What new feature would you like to see?

We already have support for MACE-MP-0, CHGNet, and M3GNet in quacc.recipes.mlp. We should also add support for:

@Andrew-S-Rosen Andrew-S-Rosen added the enhancement New feature or request label Mar 25, 2024
@Nekkrad
Copy link
Contributor

Nekkrad commented Apr 1, 2024

@Andrew-S-Rosen might be working on this in the near future (when time allows). Would you prefer expanding the pick_calculator function or creating calculators for each MLP? I reckon the first approach is probably the safest.

@Andrew-S-Rosen
Copy link
Member Author

I'd go with the former. The only time we should create a custom calculator is if the original calculator does not have all the features we need, which is rare (right now, only VASP, Espresso, and Q-Chem require this). Expanding on the picker function seems like the easiest approach to me.

It would also involve updating the tests/requirements-mlp.txt file:
https://github.com/Quantum-Accelerators/quacc/blob/main/tests/requirements-mlp.txt

as well as the pyproject.toml file:

mlp = ["matgl>=1.0.0", "chgnet>=0.3.3", "mace-torch>=0.3.3", "torch-dftd>=0.4.0", "torch<=2.2.1"]

but otherwise shouldn't be too painful.

@jackpm14
Copy link
Contributor

@Andrew-S-Rosen Might see if I can get some work in. For ALIGNN-FF, would the 'default' path be best, or would you prefer to have it added as ALIGNN-FF-Default?

@Andrew-S-Rosen
Copy link
Member Author

Andrew-S-Rosen commented Apr 24, 2024

@jackpm14: I'm a bit undecided. It seems there are several distinct ALIGN-FF models but I think if a user requested ALIGN-FF as the method they should get whatever is the current standard (presumably the default path).

Enumerating each individual model seems like a code maintenance disaster, but having just "alignff" as the method means it may make versioning less obvious as you saw with MACE-MP-0.

For now, I'd suggest just supporting "alignff" to be whatever the state of the art is at this point in time. That said, I'm very much open to suggestions here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good-first-issue
Development

No branches or pull requests

3 participants