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

Make model documentation uniform #243

Merged
merged 5 commits into from
Jun 11, 2024
Merged

Make model documentation uniform #243

merged 5 commits into from
Jun 11, 2024

Conversation

frostedoyster
Copy link
Collaborator

@frostedoyster frostedoyster commented Jun 10, 2024

Closes #232.

Now all architectures are documented in the following order:

  • Installation
  • Default hyperparameter values (showing yaml with defaults)
  • Tuning hyperparameters
  • Full hyperparameter description

📚 Documentation preview 📚: https://metatrain--243.org.readthedocs.build/en/243/

@frostedoyster
Copy link
Collaborator Author

@DavideTisi we're just missing the section on how to tune the hypers for GAP. Do you want to have a go at it or should I try?

@DavideTisi
Copy link
Contributor

I can do it, sure

@frostedoyster frostedoyster marked this pull request as ready for review June 11, 2024 08:46
@frostedoyster frostedoyster merged commit 75b4167 into main Jun 11, 2024
13 checks passed
@frostedoyster frostedoyster deleted the uniform-arch-docs branch June 11, 2024 10:17
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.

Make documentation of models uniform
2 participants