Help protect the Great Barrier Reef with TensorFlow on Kaggle Join Challenge

TensorFlowドキュメントに貢献する

TensorFlowは、ドキュメントの寄稿を歓迎します。ドキュメントを改善すると、TensorFlowライブラリ自体も改善されます。 tensorflow.orgのドキュメントは、次のカテゴリに分類されます。

いくつかのTensorFlowプロジェクトは、通常では、別のリポジトリ内のコードの近くにドキュメントのソース・ファイルを保持するdocs/ディレクトリ。プロジェクトの参照CONTRIBUTING.mdファイルをや貢献するメンテナにお問い合わせください。

TensorFlowドキュメントコミュニティに参加するには:

APIリファレンス

詳細については、使用TensorFlow APIドキュメント貢献者ガイドを。このショーは、あなたはどのように見つけるために、ソースファイルと編集シンボルのドキュメンテーション文字列を。 tensorflow.orgの多くのAPIリファレンスページには、シンボルが定義されているソースファイルへのリンクが含まれています。ドキュメンテーション文字列はサポートMarkdownをすると(約)任意の使用してプレビューすることができ値下げプレビューアを

バージョンとブランチ

サイトのAPIリファレンス最新の安定したバイナリこれまでのバージョンはデフォルトでインストールされたパッケージと一致するpip install tensorflow

デフォルトのTensorFlowパッケージは、安定した枝から構築されていrX.xメインにtensorflow / tensorflowレポ。参考資料は、ソースコード中のコードのコメントやドキュメンテーション文字列から生成されるPythonのC ++ 、およびJavaの

TensorFlowドキュメントの以前のバージョンでは、として用意されていrX.x枝TensorFlowドキュメントリポジトリに。これらのブランチは、新しいバージョンがリリースされたときに追加されます。

APIドキュメントを作成する

Pythonリファレンス

tensorflow_docsパッケージには用発電機が含まPythonのAPIリファレンスドキュメントを。インストールするには:

pip install git+https://github.com/tensorflow/docs

TensorFlow 2リファレンスドキュメントを生成するには、使用tensorflow/tools/docs/generate2.pyスクリプトを:

git clone https://github.com/tensorflow/tensorflow tensorflow
cd tensorflow/tensorflow/tools/docs
pip install tensorflow
python generate2.py --output_dir=/tmp/out

ナラティブドキュメント

TensorFlowガイドチュートリアルがように記述されているマークダウンファイルとインタラクティブJupyterのノートブック。ノートPCは使ってブラウザ内で実行することができますGoogleのColaboratoryを。上の物語ドキュメントtensorflow.orgがから構築されているtensorflow /ドキュメントのmasterブランチ。古いバージョンでは、上のGitHubで利用可能なrX.xリリースブランチ。

簡単な変更

値下げファイルに簡単なドキュメントの更新を行うための最も簡単な方法は、GitHubでの使用することですWebベースのファイルエディタを。閲覧tensorflow /ドキュメントリポジトリ大体が対応するマークダウンを見つけるために、 tensorflow.orgのURL構造。ファイルビューの右上隅にある鉛筆アイコンをクリックしますファイルエディタを開きます。ファイルを編集してから、新しいプルリクエストを送信します。

ローカルのGitリポジトリを設定する

複数ファイルの編集やより複雑な更新の場合は、ローカルのGitワークフローを使用してプルリクエストを作成することをお勧めします。

次のGit手順は、ローカルプロジェクトを初めて設定するときにのみ必要です。

tensorflow / docsリポジトリをフォークします

tensorflow /ドキュメントのGitHubページ、フォーク]ボタンをクリックしてください GitHubアカウントで独自のリポジトリコピーを作成します。フォークされたら、アップストリームのTensorFlowリポジトリでリポジトリコピーを最新の状態に保つ責任があります。

リポジトリのクローンを作成します

あなたのリモートのコピーダウンロードしusername /ドキュメントをローカルマシンにレポ。これは、変更を加える作業ディレクトリです。

git clone git@github.com:username/docs
cd ./docs

アップストリームリポジトリを追加して、最新の状態に保ちます(オプション)

同期して、あなたのローカルリポジトリを保つためにtensorflow/docs 、最新の変更をダウンロードするための上流のリモートを追加します。

リモコンを追加します。

git remote add upstream git@github.com:tensorflow/docs.git

# View remote repos
git remote -v
origin    git@github.com:username/docs.git (fetch)
origin    git@github.com:username/docs.git (push)
upstream  git@github.com:tensorflow/docs.git (fetch)
upstream  git@github.com:tensorflow/docs.git (push)

更新するには:

git checkout master
git pull upstream master

git push  # Push changes to your GitHub account (defaults to origin)

GitHubワークフロー

1.新しいブランチを作成します

あなたからあなたのレポを更新した後tensorflow/docs 、ローカルのmasterブランチから新しいブランチを作成します。

git checkout -b feature-name

git branch  # List local branches
  master

* feature-name

2.変更を加える

[編集]あなたの好きなエディタでのファイルと従ってくださいTensorFlowドキュメントのスタイルガイドを

ファイルの変更をコミットします。

# View changes
git status  # See which files have changed
git diff    # See changes within files

git add path/to/file.md
git commit -m "Your meaningful commit message for the change."

必要に応じて、コミットを追加します。

3.プルリクエストを作成します

リモートのGitHubのレポ(github.com/にお近くの支店をアップロードしusername /ドキュメント):

git push

プッシュが完了すると、メッセージにURLが表示され、プルリクエストがアップストリームリポジトリに自動的に送信される場合があります。ない場合は、に行くtensorflow / docsには、レポや独自のレポとGitHubのは、プルリクエストを作成するように求められます。

4.レビュー

メンテナおよびその他の寄稿者がプルリクエストを確認します。ディスカッションに参加して、要求された変更を加えてください。プルリクエストが承認されると、アップストリームのTensorFlowドキュメントリポジトリにマージされます。

更新するために、別の出版ステップがありtensorflow.org GitHubのレポからは。通常、変更はまとめてバッチ処理され、サイトは定期的に更新されます。

インタラクティブノートブック

それは編集のGitHubの持つノートブックJSONファイルに可能ですが、Webベースのファイルエディタ、それが不正な形式のJSONので、ファイルを破損していることができますお勧めしません。プルリクエストを送信する前に、必ずノートブックをテストしてください。

GoogleのColaboratoryは、編集、実行、ノートブックのドキュメントを簡単にそれを作るホストされたノートブック環境です。 GitHubの中にノートブックには、例えば、ノートブックは、ここでのGitHubにあり、コラボURLへのパスを渡すことで、Googleのコラボにロードされます。 https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
このURLでGoogleのコラボにロードすることができます。 https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

あるオープンコラボでGitHubの上でノートブックを閲覧するときに、このURL置換を行い、クローム拡張子が。あなたのレポフォークでノートブックを開くときに、トップボタンは常にTensorFlowドキュメントにリンクするので、これは便利であるmasterブランチ。

ノートブックのフォーマット

ノートブックフォーマットツールを使用すると、Jupyterノートブックのソース差分の一貫性が保たれ、確認が容易になります。ノートブックのオーサリング環境は、ファイル出力、インデント、メタデータ、およびその他の指定されていないフィールドに関して異なるため、 nbfmt用途はTensorFlowドキュメントコラボワークフローを優先してデフォルトを独断しました。ノートブックをフォーマットするには、インストールTensorFlowドキュメントノートブックのツールをして実行nbfmtツールを:

# Install the tensorflow-docs package:
$ python3 -m pip install -U [--user] git+https://github.com/tensorflow/docs

$ python3 -m tensorflow_docs.tools.nbfmt [options] notebook.ipynb [...]

TensorFlowドキュメントプロジェクトの場合、出力セルなしのノートブックを実行し、試験されています。そのまま保存された出力セルを持つノートブックは公開されています。 nbfmt点ノート状態と使用--remove_outputs明示的に出力セルを削除するオプションを。

新しいノートブックを作成するには、コピーして編集TensorFlowドキュメントのノートテンプレートを

Colabで編集

Google Colab環境内で、セルをダブルクリックしてテキストとコードブロックを編集します。テキスト細胞は、マークダウンを使用し、従うべきTensorFlowドキュメントスタイルガイドを

[ファイル]> [ダウンロード.pynbとのコラボからダウンロードノートブックファイル。あなたにこのファイルをコミットローカルGitのレポとプル要求を送信します。

新しいノートブックを作成するには、コピーして編集TensorFlowノートブックテンプレートを

Colab-GitHubワークフロー

ノートブックファイルをダウンロードしてローカルのGitワークフローを使用する代わりに、フォークされたGitHubリポジトリをGoogleColabから直接編集および更新できます。

  1. あなたのフォークではusername /ドキュメントレポ、するのGitHubのWeb UIを使用して新しいブランチを作成します
  2. 編集するノートブックファイルに移動します。
  3. Googleのコラボでノートブックを開きます:コラボChromeの拡張機能URLスワップまたはOpenを使用します。
  4. Colabでノートブックを編集します。
  5. ファイルとのコラボから、あなたのレポへの変更をコミット>保存のGitHubでコピー...。保存ダイアログは、適切なリポジトリとブランチにリンクする必要があります。意味のあるコミットメッセージを追加します。
  6. 、あなたのレポまたは参照保存後/ドキュメントはtensorflowレポ、GitHubのは、プルリクエストを作成するように求められなければなりません。
  7. プルリクエストはメンテナによってレビューされます。

翻訳

TensorFlowチームは、コミュニティやベンダーと協力して、tensorflow.orgの翻訳を提供します。ノートブックやその他の技術的な内容の翻訳は、に位置しているtensorflow / DOCS-L10N GitHubのレポ。プル要求を提出してくださいTensorFlow GitLocalizeプロジェクト

英語のドキュメントはソース・オブ・真実と翻訳が可能な限り近くにこれらのガイドに従うべきです。とは言うものの、翻訳は彼らが奉仕するコミュニティのために書かれています。英語の用語、言い回し、スタイル、またはトーンが他の言語に翻訳されない場合は、読者に適した翻訳を使用してください。

言語サポートは、メトリックと需要、コミュニティのサポートを含む、それにサイト限定されない多くの要因によって決定された英語能力、観客の好み、およびその他の指標。サポートされている各言語にはコストがかかるため、保守されていない言語は削除されます。新しい言語のサポートは、上で発表されるTensorFlowブログツイッター

ご希望の言語がサポートされていない場合は、オープンソースの貢献者のためにコミュニティフォークを維持することを歓迎します。これらはtensorflow.orgに公開されていません。