Google-colab-documenting-code

Google Colab-コードの文書化

コードセルは完全なPython構文をサポートしているため、コードウィンドウでPython comments を使用してコードを記述できます。 ただし、多くの場合、MLアルゴリズムを説明するために、単純なテキストベースのコメント以上のものが必要です。 MLは数学を多用しており、読者にこれらの用語や方程式を説明するには、数学表現のための言語であるLaTexをサポートするエディターが必要です。 Colabは、この目的のために*テキストセル*を提供しています。

通常MLで使用されるいくつかの数式を含むテキストセルは、以下のスクリーンショットに示されています-

数学方程式

この章で先に進むと、上記の出力を生成するコードが表示されます。

テキストセルは、 markdown -単純なマークアップ言語を使用してフォーマットされます。 テキストセルをノートブックに追加し、数式を含むテキストを追加する方法を見てみましょう。

マークダウンの例

マークアップ言語の構文のいくつかの例を見て、その機能を示しましょう。

[テキスト]セルに次のテキストを入力します。

This is **bold**.
This is *italic*.
This is ~strikethrough~.

上記のコマンドの出力は、次に示すように、Cellの右側に表示されます。

マークダウンの例

数学の方程式

• テキストセル*をノートブックに追加し、テキストウィンドウに次のマークダウン構文を入力します-

$\sqrt{3x-1}+(1+x)^2$

テキストセルの右側のパネルにマークダウンコードの即時レンダリングが表示されます。 これは、以下のスクリーンショットに示されています-

数学方程式テキストセル

*Enter* を押すと、マークダウンコードがテキストセルから消え、レンダリングされた出力のみが表示されます。

ここに示すように別のより複雑な方程式を試してみましょう-

$e^x = \sum_{i = 0}^\infty \frac{1}{i!}x^i$

クイックリファレンスとして、レンダリングされた出力をここに示します。

数式入力

サンプル方程式のコード

これは、以前のスクリーンショットに示されているサンプル方程式のコードです-

Constraints are
   - $3x_1 + 6x_2 + x_3 =< 28$
   - $7x_1 + 3x_2 + 2x_3 =< 37$
   - $4x_1 + 5x_2 + 2x_3 =< 19$
   - $x_1,x_2,x_3 >=0 $

The trial vector is calculated as follows:
- $u_i(t) = x_i(t) + \beta(\hat{x}(t) − x_i(t)) + \beta \sum_{k = 1}^{n_v}(x_{i1,k}(t) − x_{i2,k}(t))$
$f(x_1, x_2) = 20 + e - 20exp(-0.2 \sqrt {\frac {1}{n} (x_1^2 + x_2^2)}) - exp (\frac {1}{n}(cos(2\pi x_1) + cos(2\pi x_2))$

$x ∈ [-5, 5]$
>$A_{m,n} =
   \begin{pmatrix}
   a_{1,1} > a_{1,2} > \cdots > a_{1,n} \\
   a_{2,1} > a_{2,2} > \cdots > a_{2,n} \\
   \vdots > \vdots > \ddots > \vdots \\
   a_{m,1} > a_{m,2} > \cdots > a_{m,n}
   \end{pmatrix}$

完全なマークアップ構文を記述することは、このチュートリアルの範囲外です。 次の章では、作業を保存する方法を見ていきます。