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.

Sign up for GitHub

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

Jump to bottom

Improve docs for BPNN and alchemical model #130

Merged
merged 1 commit into from
Mar 1, 2024
Merged

Improve docs for BPNN and alchemical model #130

merged 1 commit into from
Mar 1, 2024

Conversation

PicoCentauri
Copy link
Contributor

@PicoCentauri PicoCentauri commented Mar 1, 2024 •
edited by github-actions bot
Loading

  • move all hyperparameter description from default yaml to docstring
  • state that alchemical and bpnn are experimental models

We should also state their actual name for the options.yaml somewhere in the docs. Currently, the hypers are listed but not the name.

📚 Documentation preview 📚: https://metatensor-models--130.org.readthedocs.build/en/130/

SanggyuChong
SanggyuChong approved these changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@SanggyuChong SanggyuChong left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for working in the docstring for per_atom_targets 😅

@PicoCentauri PicoCentauri merged commit 9895e98 into main Mar 1, 2024
10 of 11 checks passed
@PicoCentauri PicoCentauri deleted the bpnn-docs branch March 1, 2024 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SanggyuChong SanggyuChong SanggyuChong approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PicoCentauri @SanggyuChong