Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Inserting comments into jupyter notebook

I hope this is not a redundant question, but I was not able to find a proper answer and tutorial. I am currently learning Data Science and therefore use kaggle competition for practice and jupyter notebook to tackle them (as it is visually more appealing to me). Now I stumbled upon an example kernel (see: http://nbviewer.jupyter.org/github/agconti/kaggle-titanic/blob/master/Titanic.ipynb#Data-Handling) is using comments, links and illustrations between his codes to give more context.

Is anybody aware of how to write such comments and remarks within jupyter? If so, do you have an online resource where I could learn this?

Thanks a bunch!

like image 948
calicationoflife Avatar asked Feb 19 '18 15:02

calicationoflife


3 Answers

For markdown cells

[//]: # "Your comment in here."

allows to include a comment in jupyter notebook server version 6.0.1. See this discussion for more details on markdown comments.

like image 116
dgruending Avatar answered Sep 19 '22 03:09

dgruending


Agree with @RSHAP. I just add the flow picture in the below.
select the active Cell > Cell Type > Markdown. enter image description here

like image 38
Zgpeace Avatar answered Sep 20 '22 03:09

Zgpeace


Yep - highlight a cell and click on the "Cell" dropdown menu and go to "Cell Type" and choose "Markdown". Then you can type any markdown text you'd like and it will render as such.

^^ Also there are shortcuts for changing cell types as well. Highlight a cell and press the esc key to change into "command" mode and press m. This changes it to a markdown cell. Press y to change it back to a code cell.

You can also do latex equations using dollar signs ($). There is documentation for this here

like image 35
RSHAP Avatar answered Sep 21 '22 03:09

RSHAP