New tutorials #53

timnaher · 2023-04-27T11:19:18Z

Summary

added 2 tutorials on how to use ACME in a machine learning setting
changed the default ESI cluster partition in run_tests.sh from DEV to 8GBDEV

Author Guidelines

Is the change set < 400 lines?
Is the code running locally and on HPC infrastructure?
Is the code running on all supported platforms (macOS, Linux and Windows)?

Reviewer Checklist

~~Are testing routines present?~~ N/A
~~Do objects in the global package namespace perform proper parsing of their input?~~ N/A
Are all docstrings complete and accurate?
Are proposed changes tracked in CHANGELOG.md?

- rewind back to start collecting changes On branch dev Changes to be committed: modified: CHANGELOG.md

- changed the default slurm queue from DEV to 8GBDEV in run_tests.sh so that tests run and queue permission error is fixed On branch new_tutorials Changes to be committed: modified: ../../CHANGELO modified: run_tests.sh

Changes to be committed: modified: contributing.rst

- added example workflows for machine learning pipelines with ACME Changes to be committed: new file: classifier_tutorial.rst new file: deeplearning_tutorial.rst new file: images/classifier_tutorial.png

Changes to be committed: modified: CHANGELOG.md

doc/source/classifier_tutorial.rst

doc/source/deeplearning_tutorial.rst

pantaray

These are fantastic tutorials! Thanks so much @timnaher for the contribution! Where do you think would be a good place to link to them? I was thinking to put them right on the landing page as separate item in the "User Guide" section. Maybe even have them show up as separate "Tutorial" section in the top-bar menu?

Thanks again for the great work!

Changes to be committed: modified: source/classifier_tutorial.rst modified: source/deeplearning_tutorial.rst

timnaher · 2023-04-27T12:31:47Z

These are fantastic tutorials! Thanks so much @timnaher for the contribution! Where do you think would be a good place to link to them? I was thinking to put them right on the landing page as separate item in the "User Guide" section. Maybe even have them show up as separate "Tutorial" section in the top-bar menu?

Thanks again for the great work!

thanks, happy to contribute! :)
Yes, I think having them as a separate section makes sense. With time we could add some more... Maybe also some neuroscience related ones?

pantaray · 2023-04-27T17:12:43Z

Thanks for the changes - looks great! I'll put these great tutorials into a dedicated section and make them available from the top down menu. Thanks again for the fantastic work!

pantaray and others added 6 commits April 17, 2023 11:15

CHG: Prepared CHANGELOG for next release

df97203

- rewind back to start collecting changes On branch dev Changes to be committed: modified: CHANGELOG.md

Merge branch 'main' into dev

368e839

FIX: fixes bug in run_tests.sh

b885383

- changed the default slurm queue from DEV to 8GBDEV in run_tests.sh so that tests run and queue permission error is fixed On branch new_tutorials Changes to be committed: modified: ../../CHANGELO modified: run_tests.sh

FIX: fixed small typo in contributing.rst

3359abb

Changes to be committed: modified: contributing.rst

NEW: added ML tutorials

e8e8c3d

- added example workflows for machine learning pipelines with ACME Changes to be committed: new file: classifier_tutorial.rst new file: deeplearning_tutorial.rst new file: images/classifier_tutorial.png

DOC: updated CHANGELOG.md to include latest changes

c7888a2

Changes to be committed: modified: CHANGELOG.md

pantaray self-requested a review April 27, 2023 11:36

pantaray self-assigned this Apr 27, 2023

pantaray added the documentation Improvements or additions to documentation label Apr 27, 2023