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

Update README. #38

Merged
merged 1 commit into from
Jan 19, 2024
Merged

Update README. #38

merged 1 commit into from
Jan 19, 2024

Conversation

kaminow
Copy link
Collaborator

@kaminow kaminow commented Jan 18, 2024

The old README was very out of date and not relevant. Update with new example and installation instructions. Closes #37.

@kaminow kaminow requested a review from hmacdope January 18, 2024 18:20
@kaminow kaminow merged commit ee8a09a into main Jan 19, 2024
4 checks passed
@kaminow kaminow deleted the update-readme branch January 19, 2024 01:51

## Generate an instance of the mtenn SchNet model
m = SchNet()
The input passed to this model should be a `dict` with the following keys (based on the underlying model):
Copy link
Contributor

Choose a reason for hiding this comment

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

Now that I think about it more pythonic would be to pass these as named args rather than a dict with an expected structure but we can discuss as is big API change.

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.

Update README.md
2 participants