guilgautier / DPPy

Python toolbox for sampling Determinantal Point Processes
https://dppy.readthedocs.io
MIT License
219 stars 52 forks source link

Add direct link to launch the notebooks on MyBinder and Google Colab #36

Closed Naereen closed 5 years ago

Naereen commented 5 years ago

Hi! You can see on my notebooks/README.md how I added link (with badges) to launch directly the notebooks in dynamical environments online.

Example:

## 2. Question: *How to read these documents*?

### 2.a. View the _notebooks_ statically :memo:
- Either directly in GitHub: [see the list of notebooks](https://github.com/SMPyBandits/SMPyBandits/search?l=jupyter-notebook);
- Or on [nbviewer.jupiter.org](http://nbviewer.jupiter.org/): [list of notebooks](http://nbviewer.jupyter.org/github/SMPyBandits/SMPyBandits/).

### 2.b. Play with the _notebooks_ dynamically (on MyBinder) :boom:
[![Binder](https://mybinder.org/badge_logo.svg)](http://mybinder.org/v2/gh/SMPyBandits/SMPyBandits/master?filepath=notebooks)

Anyone can use the [mybinder.org](http://mybinder.org/) website (by [clicking](http://mybinder.org/v2/gh/SMPyBandits/SMPyBandits/master?filepath=notebooks) on the icon above) to run the notebook in her/his web-browser.
You can then play with it as long as you like, for instance by modifying the values or experimenting with the code.

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/SMPyBandits/SMPyBandits/master?filepath=notebooks%2FDo_we_even_need_UCB.ipynb)

- [Do_we_even_need_UCB.ipynb](https://mybinder.org/v2/gh/SMPyBandits/SMPyBandits/master?filepath=notebooks%2FDo_we_even_need_UCB.ipynb)  [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/SMPyBandits/SMPyBandits/master?filepath=notebooks%2FDo_we_even_need_UCB.ipynb)

### 2.c. Play with the _notebooks_ dynamically (on Google Colab) :boom:

Anyone can use the [colab.research.google.com/notebook](https://colab.research.google.com/notebook) website (by [clicking](XXX) on the icon above) to run the notebook in her/his web-browser.
You can then play with it as long as you like, for instance by modifying the values or experimenting with the code.

- [Do_we_even_need_UCB.ipynb](https://colab.research.google.com/github/SMPyBandits/SMPyBandits/blob/master/notebooks/Do_we_even_need_UCB.ipynb)  [![Google Colab](https://badgen.net/badge/Launch/on%20Google%20Colab/blue?icon=terminal)](https://colab.research.google.com/github/SMPyBandits/SMPyBandits/blob/master/notebooks/Do_we_even_need_UCB.ipynb)

2. Question: How to read these documents?

2.a. View the notebooks statically :memo:

2.b. Play with the notebooks dynamically (on MyBinder) :boom:

Binder

Anyone can use the mybinder.org website (by clicking on the icon above) to run the notebook in her/his web-browser. You can then play with it as long as you like, for instance by modifying the values or experimenting with the code.

Binder

2.c. Play with the notebooks dynamically (on Google Colab) :boom:

Anyone can use the colab.research.google.com/notebook website (by clicking on the icon above) to run the notebook in her/his web-browser. You can then play with it as long as you like, for instance by modifying the values or experimenting with the code.

guilgautier commented 5 years ago

Hi @Naereen! This is a very interesting suggestion :) I've been thinking about it since the Tuto_DPPy.ipynb was actually created on Google Colab, but I didn't know how useful it would be at that time.

Naereen commented 5 years ago

Another example of Markdown code, for another of my repository:


[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/Naereen/ParcourSup.py/master?filepath=notebooks%2FParcourSup.py_version_simplifiee.ipynb)

[![Google Colab](https://badgen.net/badge/Lancer/sur%20Google%20Colab/blue?icon=terminal)](https://colab.research.google.com/github/Naereen/ParcourSup.py/blob/master/notebooks/ParcourSup.py_version_simplifiee.ipynb)

Binder

Google Colab

Naereen commented 5 years ago

I guess this is enough. Tell me what you think @guilgautier and merge #37 if you like it!

guilgautier commented 5 years ago

Looks great! I am about to merge #37 Thanks very much 🙏

Naereen commented 5 years ago

Great!