TensorFlowの日本語まとめ

TensorFlowの公式サイトに書かれている英文を英語ど素人が翻訳(日本語訳/和訳)します。 間違いがありましたら、優しく教えていただけますと幸いです。 内容を理解したら、使ってみたい。

5.Docstringセクションの説明

ここでdocstringの各要素のためのより多くの詳細および実施例です。

 

opは何をするか説明する短い

例えば、

Concatenates tensors.

Flips an image horizontally from left to right.

Computes the Levenshtein distance between two sequences.

Saves a list of tensors to a file.

Extracts a slice from a tensor.

 

f:id:TensorFlow:20160111204304j:plain

スポンサーリンク

 

OPに引数を渡すときに何が起こるかの簡単な説明。

例えば、

Given a tensor input of numerical type, this operation returns a tensor of
the same type and size with values reversed along dimension `seq_dim`. A
vector `seq_lengths` determines which elements are reversed for each index
within dimension 0 (usually the batch dimension).

This operation returns a tensor of type `dtype` and dimensions `shape`, with
all elements set to zero.

 

opがどのように動作するかを示す例

squeeze()opは素敵な擬似コードがあります。:

shape(input) => `[1, 2, 1, 3, 1, 1]`
shape(squeeze(input)) =>  `[2, 3]`

tile()opは説明文では良い例を提供します。

For example, tiling `[a, b, c, d]` by 2 produces
`[[a, b, c, d], [a, b, c, d]]`.

Pythonでコードサンプルを表示することがしばしば有用です。OPSファイルをC++とPython OPSドキュメントでそれらを置かないでくださいOPSのコンストラクタが呼び出されているモジュールやクラスのdocstringに入れて。

 

ここではimage_ops.pyのモジュールのdocstringからの例です。:

Tensorflow can convert between images in RGB or HSV. The conversion
functions work only on `float` images, so you need to convert images in
other formats using [`convert_image_dtype`](#convert-image-dtype).

Example:

```python
# Decode an image and convert it to HSV.
rgb_image = tf.image.decode_png(...,  channels=3)
rgb_image_float = tf.image.convert_image_dtype(rgb_image, tf.float32)
hsv_image = tf.image.rgb_to_hsv(rgb_image)
```

要件警告重要な注意事項

例えば、:

This operation requires that: `-1-input.dims() <= dim <= input.dims()`

Note: This tensor will produce an error if evaluated. Its value must
be fed using the `feed_dict` optional argument to `Session.run()`,
`Tensor.eval()`, or `Operation.run()`.

引数と出力(returned)テンソルの説明。

簡潔かつポイントに説明をしてください。あなたは、操作は、引数のセクションでどのように機能するかを説明する必要はありません。

 

OPは、入力または出力テンソルの大きさに強い制約がある場合に言及してください。C++ OPSのためにそれを覚えて、テンソルのタイプは自動的に"A ..type.. Tensor"または"A Tensor with type in {...list of types...}"のいずれかとして追加されます。このような場合、OPは、寸法上の制約がある場合などのテキストを追加するいずれかの「4-Dでなければなりません」または=(追加するテンソルの種類を防ぐために)と「4-Dのフロートテンソル」のような何かを書くと説明を始めます。例えば、ここでC++ OPの画像引数("="記号に注意してください)を文書化する2つの方法があります。

image: Must be 4-D. The image to resize.

image:= A 4-D `float` tensor. The image to resize.

ドキュメントではこれらのは次のようにmarkdownレンダリングされます。

image: A `float` Tensor. Must be 4-D. The image to resize.

image: A 4-D `float` Tensor. The image to resize.

オプションの引数の説明("attrs")

いずれの場合ドキュメントジェネレータは、常に、attrsにタイプとデフォルト値を記述します。説明はC++非常に異なっているとPythonは、ドキュメントを生成するので、あなたは、等号でそれを上書きすることはできません任意の追加のattrの説明フレーズは、型とデフォルト値の後に流れるようにします。


ここではimage_ops.pyからの例です。:

REGISTER_OP("PngDecode")
    .Input("contents: string")
    .Attr("channels: int = 0")
    .Output("image: uint8")
    .Doc(R"doc(
Decode a PNG-encoded image to a uint8 tensor.

The attr `channels` indicates the desired number of color channels for the
decoded image.

Accepted values are:

*   0: Use the number of channels in the PNG-encoded image.
*   1: output a grayscale image.

...

contents: 0-D. The PNG-encoded image.
channels: Number of color channels for the decoded image.
image: 3-D with shape `[height, width, channels]`.
)doc");

これは、以下の"Args"セクションを生成します。

  contents: A string Tensor. 0-D. The PNG-encoded image.
  channels: An optional `int`. Defaults to 0. Number of color channels for the
    decoded image.
  name: A name for the operation (optional).

 

 

(原文)

Writing TensorFlow Documentation