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

金融と工学のあいだ

興味関心に関するメモ(機械学習、検索エンジン、プログラミングなど)

Chainerにコントリビュート ~Documentation編~

Chainerにコントリビュートしよう

  • 以下がDocumentationに関するIssue。

github.com

  • その中でも関数の説明に関するIssueがこれ。

github.com

作業手順

手順の確認

[WIP] Improve docs of functions and links · Issue #2182 · pfnet/chainer · GitHubに手順が書いてるので確認

gitレポジトリの準備

  1. 自分のスペースにchainerをforkする(pfnet/chainerのmasterと自分のmasterが追従するようにはここ )
  2. documentation用のbranchを作成する(ex. improve-docs-examples)

softmax関数にDocumentationを追加してみよう

  1. 様子を見る
  2. 既にDocumentation済みの関数を見てみる
    • 同様に、関数にはdocは付いているが、クラスにはついていない。
    • ただ、よりtemplateに近い形になるように関数のdocが修正されている。
  3. テンプレートを見る

    chainer/sigmoid.py at master · pfnet/chainer · GitHub

  4. 真似して書く

  5. ちゃんと生成できるかチェックする
  6. プルリクエスト作成