読者です 読者をやめる 読者になる 読者になる

TensorFlow のドキュメントをサクッと読む方法 / one-liner: How to read TensorFlow documents in Python instantly

TensorFlow python tips machine learning

TensorFlow のドキュメントをサクッと読む方法 / How to read TensorFlow documents instantly in Python

** Sorry, this note is Japanese only, but please take a look at some code snippets. Hope it helps you a bit!

機械学習にも Deep Learning にも TensorFlow にも未だに全くなれないワタクシ。
しょっちゅうドキュメントを確認しないといけないことがあります。
こんな時 TensorFlow は公式ドキュメントが充実してたり、先駆者の皆さんがブログに書いてくれたりするので助かるのですが、丁寧なドキュメントじゃなくていいので、サクッと TensorFlow の仕様を確認したい時もあります。

今日はそんな時のための Tips です。

TensorFlow の公式ドキュメントと情報源

・・・

ググればたっぷり出てくるわけですが・・・
その中でもよく見てるなーと思うものをあげると、こんな感じです。

TensorFlow 公式ドキュメント
GET STARTED(英語) にお世話になった方は多いハズ。
あとは、ググると Qiita がよく検索にヒットしますね、やっぱり。

この辺のドキュメントは内容が充実しててとても助かるのですが、最近は API(これも英語><) の確認をすることも多くなってます。

TensorFlow のドキュメントをサクッと読む方法

ところで、いちいちブラウザ開くのがめんどくさいなー、って。
さっきの API ドキュメントを読んでると気づいたことが。

・・・

・・・

・・・この文章どっかで見たことある・・・

!!

そう、TensorFlow 自体のソースのコメントに結構ちゃんと書いてあるんですね。
例えば、TensorFlow の tf.Graph クラスだとこんな感じ。

API ドキュメント:

class tf.Graph

A TensorFlow computation, represented as a dataflow graph.
A Graph contains a set of Operation objects, which represent units of computation; and Tensor objects, which represent the units of data that flow between operations.

一方、該当部分( tf.Graph )のソースのコメント:

class Graph(object):
"""A TensorFlow computation, represented as a dataflow graph.
A Graph contains a set of
Operation objects,
which represent units of computation; and
Tensor objects, which represent
the units of data that flow between operations.

同じだっっ!
これは、docstring とかいうやつらしく、Python だとクラスやメソッドの定義部分に ””” でコメントして記述したもので、各オブジェクトの doc に紐づけられているんですね。さらに、最近の Python のドキュメント生成ツールは、この docstring からドキュメントを作ってるようです。
きちんと docstring を書いてくれているソースだとこの docstring を参照すれば、ある程度のことがわかるようになってて、TensorFlow もキッチリ書いてくれてます!

と、いうわけで、作業中とかだと、こんなワンライナーで TensorFlow のドキュメントを確認しています。

python -c "import tensorflow as tf; print(tf.Graph.doc)" | less

追伸:
コメントでより良い方法をご指摘いただきました。

python -c "import tensorflow as tf; help(tf.Graph)"

こちらの方が読みやすいのでオススメです。
id:sugyan さん、ありがとうございました!

TensorFlow 関連の他の記事

datalove.hatenadiary.jp datalove.hatenadiary.jp datalove.hatenadiary.jp datalove.hatenadiary.jp