intro-stat-learning / ISLP_labs

Up-to-date version of labs for ISLP
BSD 2-Clause "Simplified" License
660 stars 388 forks source link

JupyterBook? #9

Open tschm opened 1 year ago

tschm commented 1 year ago

Going forward I would like to make sure that all notebooks are executed once they have been committed. This will add some extra level(s) of robustness. This could be done in the context of a JupyterBook that would iterate over all of them and put them into a book.

jonathan-taylor commented 1 year ago

Yes, I am aware of how pre-commits work.

I am already running the labs before pushing. This repo is not the place for this.

This is why I've closed this PR.


From: Thomas Schmelzer @.> Sent: Tuesday, August 22, 2023 11:17 AM To: intro-stat-learning/ISLP_labs @.> Cc: Subscribed @.***> Subject: [intro-stat-learning/ISLP_labs] JupyterBook? (Issue #9)

Going forward I would like to make sure that all notebooks are executed once they have been committed. This will add some extra level(s) of robustness. This could be done in the context of a JupyterBook that would iterate over all of them and put them into a book.

— Reply to this email directly, view it on GitHubhttps://github.com/intro-stat-learning/ISLP_labs/issues/9, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AACTM27IGX5K4N5BOLPKG2TXWTZTNANCNFSM6AAAAAA32J7IUU. You are receiving this because you are subscribed to this thread.Message ID: @.***>

tschm commented 1 year ago

You mean you run the labs locally before every push? I don't wanna stop you in doing that but to make sure nothing is broken it's a good idea to repeat this step in an automated workflow... My comment above is unrelated to pre-commit

jonathan-taylor commented 1 year ago

Thanks. I realize your intention is good. I'm aware it would be good in a workflow but this is not how this is being done.

I do actually have some familiarity with good practices in open source.


From: Thomas Schmelzer @.> Sent: Tuesday, August 22, 2023 11:25 AM To: intro-stat-learning/ISLP_labs @.> Cc: Jonathan Taylor @.>; Comment @.> Subject: Re: [intro-stat-learning/ISLP_labs] JupyterBook? (Issue #9)

You mean you run the labs locally before every push? I don't wanna stop you in doing that but to make sure nothing is broken it's a good idea to repeat this step in an automated workflow... My comment above is unrelated to pre-commit

— Reply to this email directly, view it on GitHubhttps://github.com/intro-stat-learning/ISLP_labs/issues/9#issuecomment-1688702508, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AACTM2ZTY6KB56JFO635QH3XWT2S3ANCNFSM6AAAAAA32J7IUU. You are receiving this because you commented.Message ID: @.***>

tschm commented 1 year ago

You are certainly by far the best academic I came across when it comes to adopting good DevOps practices :-) Of course, you may argue that you test your notebooks already downstream in the development process of ISLP --- the package. And that's good, too. However, I think given you don't have to pay for running those workflows there is no harm to run through them again, in particular that you get a beautiful JupyterBook as a byproduct.

tschm commented 1 year ago

Given your personal tastes, you may enjoy browsing through https://github.com/cvxgrp/.github You would be the 2nd user in the stats department :-)

tschm commented 1 year ago

and https://www.cvxgrp.org/cvx_short_course/docs/index.html