Skip to content

Switch to TD-pos-only as default recommendation in docs#76

Merged
t-reents merged 1 commit into
mainfrom
imp/docs-hugging-face
Jun 17, 2026
Merged

Switch to TD-pos-only as default recommendation in docs#76
t-reents merged 1 commit into
mainfrom
imp/docs-hugging-face

Conversation

@t-reents

Copy link
Copy Markdown
Collaborator

Previously, the docs were always discussing the MatterGen baseline model as a reference. However, it makes much more sense to directly show the users how to use the recommended model shipped with XtalPaint.

To make it work out of the box (this was the motivation to use the MatterGen baseline model in previous examples), a utility was added to automatically download the XtalPaint models from Hugging Face in case they are not available, yet.

@t-reents t-reents linked an issue Jun 17, 2026 that may be closed by this pull request
Previously, the docs were always discussing the MatterGen baseline model
as a reference. However, it makes much more sense to directly show the
users how to use the recommended model shipped with XtalPaint.

To make it work out of the box (this was the motivation to use the
MatterGen baseline model in previous examples), a utility was added to
automatically download the XtalPaint models from Hugging Face in case
they are not available, yet.
@t-reents t-reents force-pushed the imp/docs-hugging-face branch from 5a516d2 to 2952e90 Compare June 17, 2026 10:06
@t-reents t-reents merged commit 6d6e086 into main Jun 17, 2026
5 checks passed
@t-reents t-reents deleted the imp/docs-hugging-face branch June 17, 2026 10:10
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.

Improve documentation and examples

1 participant