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 tutorial text #60

Open
5 of 10 tasks
Tracked by #48
ri-heme opened this issue Nov 22, 2022 · 0 comments
Open
5 of 10 tasks
Tracked by #48

Update tutorial text #60

ri-heme opened this issue Nov 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ri-heme
Copy link
Collaborator

ri-heme commented Nov 22, 2022

Changes to tutorial:

  • Indicate that one should do hyperparameter optimization before running analyze latent?
  • How to download tutorial data if not cloning via git (perhaps from link/wget on Zenodo or similar)
  • Indicate where and which output files one should look at. E.g. from Tuning the hyperparameters indicate where the output will be
  • in a how-to-run-on-my-data: Indicate what should be done to run on my own data, e.g. as much help as possible will make it easier for beginners to run it
  • Indicate how long time it took to run the tutorial for you using CPUs, e.g. so users know they dont need GPU to run
  • Add that log-file with more details is written as logs/identify_associations.log (for instance)
  • Indicate that identify_associations_ttest will run 4 models each with different latent size. Each model is run 10 times for a total of 40 models
  • Is it possible to add a small helper script to check the overlap of significant features and the truth data (probably done in notebook)
  • Note that running bayes association overwrites the output of ttest association
  • Front readme: Indicate how to install from git clone
@ri-heme ri-heme added the documentation Improvements or additions to documentation label Nov 22, 2022
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
Projects
None yet
Development

No branches or pull requests

1 participant