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

Add table/section on the scientific usecases to the READMEs #721

Closed
5 tasks done
elboyran opened this issue Feb 29, 2024 · 2 comments · Fixed by #754
Closed
5 tasks done

Add table/section on the scientific usecases to the READMEs #721

elboyran opened this issue Feb 29, 2024 · 2 comments · Fixed by #754
Assignees
Labels
documentation Improvements or additions to documentation outreach advertising beyond publication label

Comments

@elboyran
Copy link
Contributor

elboyran commented Feb 29, 2024

  • Mention scientific tutorials in the key-points of dianna
  • Update README on tutorials and data/explainer plans
  • A separate table in the main README with these tutorials
  • Paragraph/separate section/table about these tutorials in the tutorials README
  • Improve the hyperparameter values tables with a one-liner explanation of the expected effect of changing each parameter. For instance for 'n_mask': "Higher values increase stability at the cost of computation time." as suggested by @cwmeijer in PR Importance of hyperparameters #737.
@elboyran elboyran added documentation Improvements or additions to documentation outreach advertising beyond publication label labels Feb 29, 2024
@elboyran elboyran self-assigned this Feb 29, 2024
@elboyran elboyran changed the title Add special section on the scientific usecases to README Add table/section on the scientific usecases to the READMEs Mar 13, 2024
@elboyran elboyran linked a pull request Apr 19, 2024 that will close this issue
@elboyran

This comment was marked as outdated.

@elboyran
Copy link
Contributor Author

@cwmeijer if you know about more expected effects from changing the hyperparameters than given in WIllem's thesis and the related PR, please, add them in the Tutorial's README extension.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation outreach advertising beyond publication label
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant