Jupyter notebook メモ書き をコード中に記入するMarkdown記述まとめ

プログラミングを学んでいくなかで、jupyter notebookを使いこなすことは、学習効率をあげるうえで大切です。

ここでは、私が学習していくなかで便利だと思った機能を紹介していきます。

コードの実行部と説明部を分けられる

書籍を読みながらプログラミングの勉強をする場合、実行のための[コード]と、そのコードの意味や行いたい処理に関する[説明]が併記されている場合がほとんどだです。

プログラミング学習をしている最中は、そのコードの意味がわかっていても時間をおいて読み返したときにふと「このコードはどのような意味をもつのだっけな」と忘れてしまうことが多々あります。

また、書籍には書かれていない自分ならではの気づきや感想を残したくなるときもあるかと思います。

そんなときに私はJupyter notebook中にメモを残しております。

Jupyter notebookでメモを残す方法

Jupyter notebookでは、そのまま文字列をメモとして入力したらコーディングエラーと表示されてしまいます。
なので、メモをとるときにはその文字列が「実行と関係のない文字列である」ということを示す必要があります。
そのメモを残す方法は以下の2つです。

  1. セル内に“#(シャープ)”をつけてテキストアウトする
  2. セルをMarkdown形式にして入力する

それぞれの方法について見ていきます。

“#(シャープ)”をつける

一番簡単な方法は“#(シャープ)”を、入力行の先頭につけることです。

そうすることで、Jupyter notebook内では「緑色」にテキストが表示されて”#(シャープ)”以降の入力は全てプログラムの実行から除外されます。
つまり、このようにしてメモとして残せます。

jupyter notebook #テキストのスクリーンショット

jupyter notebook #テキスト

ただし、実行から除外されるのは”#(シャープ)”をつけた1行のみなので、メモが長文になる場合には表示画面からはみだしてしまうこともあります。
また、改行をした際にも”#(シャープ)”を再度つけなおす必要がありますので、場合によっては可読性が落ちてしまいます。
メモが長文にわたる場合には次に紹介“Markdown”によるテキスト入力がおすすめです。

Markdownでテキスト形式

この”Markdown”はJupyter notebookのセル全体をテキスト入力のためのセルとして用いる際に使います。

設定方法は2つあり、

セルタイプを一覧から選択

In[ ]と書かれたセルを選んだ後に、jupyter notebook上部の初期状態で”Code ▼”と書かれている選択ボックスをクリックしたのちに現れる”Markdown”を選択します。
入力後に”Shift + Enter”で、Markdown形式のテキストセルが表示されます。

jupyter notebook Markdown

「Commandモード」でショートカットキー「M」キーを押す

もう一つの方法は、「Command mode」といってCellの左側が青色に表示されている状態で、ショートカットキーとして「M」キーを押すことで選択したセルがMarkdownセルとなります。

この「Command mode」にするには、[Esc]キーを入力することで切り替えることができます。

Jupyter notebookのショートカット機能は覚えておくと便利なのでどんどん使いこなしていきましょう。

頻出!Markdownの記述方法を紹介

以下にMarkdownでテキスト入力をしていく際によく使う記述方法をまとめました。

これらの記述方法を覚えることで、以下のように整理されたテキストを作成することができ、学習した内容や自分が作成したコードをわかりやすく記録するためにも非常に重要です。

Markdownで表題作成

Markdownセルで”#(シャープ)”を入力すると、その後の入力が表題として表示されます。
“#(シャープ)”1つで最も大きい表題で、その後”#(シャープ)”の数を増やすごとに小さな表題となります。

Markdownで箇条書き

Markdownセルで、行の頭に“-(マイナス)”と” (半角スペース)”を入力することで箇条書き表示されます。
Markdownセルで、行の頭に”1(数字)”と”. (ドット)”+” (半角スペース)”を入力することで数字つきの箇条書き表示されます。

Markdownで改行

Markdownセルでは、通常と同じように[Enterキー]を押しても、セルを実行すると改行が反映されません。

改行のためには、[半角スペース]2つの後に[改行] or <br>を入力が必要となります。

Markdownで表を作成する

Markdownセル中に表を作成することも可能です。表作成にはパイプ記号「|」を用います。

例えば以下に3行 * 3列の表の記入例を示します。

パイプ記号「|」で区切りを作成した分だけ行・列が追加されていきます。

また、表の「左揃え・中央ぞろえ・右揃え」は2列目の表記方法で変更することができます。

Markdownでリンクの埋め込み

作業中に参照したサイトやデータセットの出典を記録にスマートに残したいときに便利なのがこのリンクの埋め込み機能です。

リンクで示したいテキストを「[ ]」で囲い、そのあとにリンク先のURLを「( )」内に入力します。

最後に これからエンジニア / データサイエンティストを目指す人へ

jupyter notebookでの学習効率をあげるうえで大切な、Jupyter notebook中にメモを残す方法を紹介しました。この機能を活用することで、
「このコードはどのような意味をもつのだっけな」と忘れてしまうことを防ぎ、書籍には書かれていない自分ならではの気づきや感想を残すことができます。

また、既にJupyter notebookを使用していて学習を進めているかたは以下の記事も学習に役立つかと思いますのでご覧ください。

今回の情報が同じく人工知能を学んだりデータサイエンティストを目指している人の役に立てればなと思います。

データサイエンティストには高度な知識が要求されて、学習するのが大変!と思う人も多いかと思いますが、この記事で紹介されているように今後10年、20年先の鍵となる知識・技術です。

もし、独学での学習である程度の領域まで達成できた後は実践だ、という人やスクールに通ってもっと専門的な知識を学びたいという方には、以下のデータサイエンティスト向けの講座がおすすめです。なぜなら国の補助金制度を活用しながら自分の専門性を高めることができるからです。

自分に適した学習方法を確立させて将来のためのスキルアップを目指しましょう!

スポンサーリンク

シェアする

  • このエントリーをはてなブックマークに追加

フォローする

%d人のブロガーが「いいね」をつけました。