search

dkirkby / MachineLearningStatistics

Machine learning and statistics for physicists
BSD 3-Clause "New" or "Revised" License
94 stars 53 forks source link

Add nbviewer and license badges to README #1

Closed matthewfeickert closed 6 years ago

matthewfeickert commented 6 years ago

The nbviewer badge added to the README is hyperlinked to the nbviewer page for the MachineLearningStatistics repo. This makes it easier to view the notebooks as a set of nicely rendered notes in browser (as compared to the view of the notebook that GitHub offers).

matthewfeickert commented 6 years ago

@dkirkby I was talking with @alexarmstrongvi at CERN today and he mentioned this repo to me (quite nice). Just thought that it might be nice to add some badges to the README especially if people are going to try to read them as in browser static notes in addition to using the Jupyter notebooks.

Let me know if you have any requests or edits that you'd like.

dkirkby commented 6 years ago

Thanks, I didn't know about nbviewer badges. The performance (and rendering) are much nicer for read-only browsing.

Perhaps a link to the Contents notebook would be a more useful entry point than the notebooks dir?

Btw, a condensed and somewhat overlapping set of notebooks from a recent summer school are here.

dkirkby commented 6 years ago

Are these badges documented anywhere? I only found some issue traffic. I am wondering if there is a similar badge for starting nbviewer in the "View as slides" mode.

matthewfeickert commented 6 years ago

Perhaps a link to the Contents notebook would be a more useful entry point than the notebooks dir?

Sure. That actually works really nicely on nbviewer too.

Any interest in having a duplicate of the Contents.ipynb content in a README.md in notebooks? This would have the advantage that it would automatically load when the dir is visited on GitHub.

Btw, a condensed and somewhat overlapping set of notebooks from a recent summer school are here.

Thanks! I'll check them out too.

matthewfeickert commented 6 years ago

Are these badges documented anywhere?

They're all generated automatically from https://shields.io/

Is [there] a similar badge for starting nbviewer in the "View as slides" mode?

The answer seems to be kinda, but using slideviewer instead of nbviewer. However, slideviewer seems to require a url to an actual Jupyter notebook, instead of just a directory above where they exist. So you could create individual badges, but maybe not just a single one. However, this was also just from 5 minutes of searching so there might be a better solution in a GitHub Issue somewhere.

For my own (local and Binder) personal presentations I just use RISE. Example here (click the "launch binder" badge and then navigate to Notebooks/Slides.ipynb for a live demo).

matthewfeickert commented 6 years ago

@dkirkby Okay, with ad8485c1e755e5d53c73f72881053917cde21d24 the nbviewer badge now links to the TOC notebook.

dkirkby commented 6 years ago

Any interest in having a duplicate of the Contents.ipynb content in a README.md in notebooks?

The Contents nb already contains most of the info in the README, and I try to avoid linking to the directory.

dkirkby commented 6 years ago

I just added a "slides" badge to this README that links directly to nbviewer with /format/slides/ in the URL.

matthewfeickert commented 6 years ago

The Contents nb already contains most of the info in the README, and I try to avoid linking to the directory.

Sure. Just to be clear on what I was suggesting (I may have not done a good job of describing it) was to take the TOC from Contents.ipynb and add that to a notebooks/README.md so that if someone were to visit MachineLearningStatistics/notebooks they would see the rendered TOC instead of just all of the files. But maybe you're linking to the directory comment is associated with the idea that you aren't expecting people to be navigating around on GitHub so much, especially if nbviewer is in place.

I just added a "slides" badge to this README that links directly to nbviewer with /format/slides/ in the URL.

Hey that's great! Thanks for the tip. :+1:

dkirkby commented 6 years ago

Just to be clear on what I was suggesting

Ok, I misunderstood.

they would see the rendered TOC instead of just all of the files

Wouldn't the rendered TOC still appear below the (longish) listing of files?

you aren't expecting people to be navigating around on GitHub so much

Yes, that's what I meant.

matthewfeickert commented 6 years ago

Wouldn't the rendered TOC still appear below the (longish) listing of files?

True. So probably not really worth it.

dkirkby commented 6 years ago

Btw, are you working with Bob Kehoe at SMU? (We collaborate on DESI).

matthewfeickert commented 6 years ago

@dkirkby Nope. I work with @stephensekula on ATLAS.