Google-colab-documenting-code
提供:Dev Guides
Google Colab-コードの文書化
コードセルは完全なPython構文をサポートしているため、コードウィンドウでPython comments を使用してコードを記述できます。 ただし、多くの場合、MLアルゴリズムを説明するために、単純なテキストベースのコメント以上のものが必要です。 MLは数学を多用しており、読者にこれらの用語や方程式を説明するには、数学表現のための言語であるLaTexをサポートするエディターが必要です。 Colabは、この目的のために*テキストセル*を提供しています。
通常MLで使用されるいくつかの数式を含むテキストセルは、以下のスクリーンショットに示されています-
この章で先に進むと、上記の出力を生成するコードが表示されます。
テキストセルは、 markdown -単純なマークアップ言語を使用してフォーマットされます。 テキストセルをノートブックに追加し、数式を含むテキストを追加する方法を見てみましょう。
マークダウンの例
マークアップ言語の構文のいくつかの例を見て、その機能を示しましょう。
[テキスト]セルに次のテキストを入力します。
上記のコマンドの出力は、次に示すように、Cellの右側に表示されます。
数学の方程式
- テキストセル*をノートブックに追加し、テキストウィンドウに次のマークダウン構文を入力します-
テキストセルの右側のパネルにマークダウンコードの即時レンダリングが表示されます。 これは、以下のスクリーンショットに示されています-
ここに示すように別のより複雑な方程式を試してみましょう-
クイックリファレンスとして、レンダリングされた出力をここに示します。
サンプル方程式のコード
これは、以前のスクリーンショットに示されているサンプル方程式のコードです-
完全なマークアップ構文を記述することは、このチュートリアルの範囲外です。 次の章では、作業を保存する方法を見ていきます。