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

M3GNetSite describer; DIRECT samples smallest cells possible #596

Merged
merged 23 commits into from
Mar 20, 2024

Conversation

JiQi535
Copy link
Collaborator

@JiQi535 JiQi535 commented Jan 28, 2024

Summary

Addition of functionalities for DIRECT sampling and describer. All are covered by tests.

Major changes:

  • Add M3GNetSite as a describer.

  • Add "smallest" and "random" as selection_criteria for the stratified sampling step of DIRECT sampling pipeline. The default selection_criteria is still "center", i.e., select structures w.r.t. their distances to the respective centroid.

  • Allow DIRECT sampling to decide # of clusters based on desired cluster radius.

  • Add tests to all above functionalities and previous missing ones.

  • Corrections for typos for DIRECT sampling codes and notebooks.

  • Additional docs all over maml to pass ruff and black.

Todos

  • The M3GNet structural and atomic featurizer are all based on tensorflow version of M3GNet. MatGL models are to be added.
  • A notebook of DIRECT sampling with atom features.

Checklist

  • Google format doc strings added. Check with ruff.
  • Type annotations included. Check with mypy.
  • Tests added for new features/fixes.
  • If applicable, new classes/functions/modules have duecredit @due.dcite decorators to reference relevant papers by DOI (example)

Copy link

codecov bot commented Jan 28, 2024

Codecov Report

Attention: Patch coverage is 90.90909% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 67.58%. Comparing base (eb4a8ea) to head (1463eee).

Files Patch % Lines
maml/apps/pes/_mtp.py 50.00% 3 Missing ⚠️
maml/describers/_m3gnet.py 92.68% 3 Missing ⚠️
maml/apps/gbe/describer.py 50.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #596      +/-   ##
==========================================
+ Coverage   66.92%   67.58%   +0.66%     
==========================================
  Files          68       68              
  Lines        5209     5263      +54     
==========================================
+ Hits         3486     3557      +71     
+ Misses       1723     1706      -17     

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

@JiQi535 JiQi535 requested a review from shyuep January 28, 2024 18:30
@shyuep shyuep merged commit 2c1bf6a into materialsvirtuallab:master Mar 20, 2024
6 of 7 checks passed
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.

2 participants