ドキュメンテーションのすヽめ_#MLbeginners

ML for Beginners! MeetUp登壇資料
#MLbeginners

Transcript

1. υΩϡϝϯςʔγϣϯͷ͢ʍΊ Recommend to Documentation
2. Recommend to Documentation 免責事項 / お願い - 本登壇は個⼈の⾒解であり、所属する組織の公式⾒解ではありません - 社会⼈2年⽬のビギナーなので優しい⽬で⾒てください -「お気持ち」的な内容がメインになります - 受託分析データサイエンティスト視点なので、多少バイアスがあります - ツイッターにたくさんつぶやくと運営&⾃分が喜びますので、たくさんツイートしてください 2/14
3. Recommend to Documentation 質問 ドキュメンテーション⼤切だと感じたことある⽅︕︕ (深掘り) いつ / どうして そう思ったかを 考えました︖ 「誰か」に「何か」を伝えることって⼤切
4. Recommend to Documentation ⾃⼰紹介 学⽣ 早稲⽥⼤学 創造理⼯学研究科 経営システム⼯学専攻 共同研究先のマーケティングデータ × データサイエンス 仕事 データサイエンティスト @BrainPad 2018年新卒 強化学習 / NLP / 統計的因果推論 / 画像異常検知 趣味 仁ノ平 将⼈ Masato Ninohira (@nino_pira) Data Gateway Talk 主催 B’zファン(⾳楽×データ分析のイベント企画now) ブログ︓データサイエンティスト⾒習いの⽇常 フットサル 4/14
5. Recommend to Documentation ⽬次 - Why Documentation? - ドキュメントの分類 - コード / 分析レポート - まとめ 5/14
6. Recommend to Documentation ⾃分の記憶の共有 = 不可能 Why Documentation︖ Impossible to SHARE Brain 「誰か」に「何か」を伝えたい Idea ケースに応じたドキュメンテーション Want to SHARE Idea SHARE by Document SHARE 6/14
7. Recommend to Documentation ドキュメントの分類 ※MECEではないです。作為的に⽊を切っています ※「メール / 議事録」も考えましたが、分析内容を 直接書くことは稀だと思いましたのでスコープ外 Who - 分析チーム - 意思決定者 - コンピュータ - 分析結果 / next アクション - 意思決定者への レポートに必要な素材選定 - ⾃分のコードの確認 - 分析の結果を正しく伝え、意思決定のサポート - 回るコード / 早いコード - 分析レポート - コード - 分析レポート What Document - コード 「誰」に「何を伝えたいか」の構造化が良いドキュメント化へのポイント 7/14
8. Recommend to Documentation コード コンピュータ & ⼈間に読みやすいコード 計算速度 冗⻑なコードの回避 例︓ 組み込み関数のsumを使う 可読性の⾼い実装 - 明瞭なディレクトリ構成 - コーディング規約 /適切なコメント - 明瞭なプルリク 8/14
9. Recommend to Documentation 参考︓ ディレクトリ構造のテンプレ ⾃分はこれに⾃分専⽤の 開発環境特化素材を加えてる (例︓Docker) 9/14
10. Recommend to Documentation 分析レポート 前提 1. 分析には「⽬的」があり「概要」/ 「結果」があり「Next Action」が絶対にある 2. 対象者が求めているレベル感に合わす 意思決定者 詳しく知りたい 結果だけ知りたい 分析メンバー 社内wiki / 分析レポート 詳しく知らせる必要がある スライド 作成モデルをシステム化することでxx万円の売り上げ向上 コスト︓xxx Income︓xxx ROI︓xxx (期間︓zzxxx~xxxx) 作成モデルをシステム化することでxx万円の売り上げ向上 モデルの精度 学習︓xxx テスト︓xxx 分析⽬的︓xxxx 概要︓xxxx 結果︓xxxx Next Action︓xxxx 詳細︓xxx ※綺麗なスライドの作り⽅は世の中に 良い本がたくさんあるのでそちらで学んで頂ければと思います Who Level Doc ロジックツリー ここがxx%up 結局、分析結果をステークホルダーに伝えられないとその分析に価値はない 10/14
11. Recommend to Documentation 参考︓コンフルエンスを⽤いた分析レポート作成 オンラインで共有 = 情報の共有の閾値が低 (全ての実験結果をコンフルに記載) 11/14
12. Recommend to Documentation 参考︓分析レポート以外の記事もたくさん書いてます 12/14
13. Recommend to Documentation 参考︓どう鍛えるの︖ 意識して経験するしかないと思っています。。。 Do Best Every Time ※むしろ良い⽅法をご存知の⽅教えてください、、、 13/14
14. Recommend to Documentation まとめ - 情報の伝達⼿段としてドキュメンテーションは有効 - 「誰」に「何を」伝えたいかの「構造化」を意識したドキュメント化 14/14
15. Recommend to Documentation 参考⽂献 - はじめてのNoteと、ドキュメンテーションについて (本登壇はこの資料に超影響を受けてます) - 1分で話せ 世界のトップが絶賛した⼤事なことだけシンプルに伝える技術 - イシューからはじめよ 知的⽣産の「シンプルな本質」 - なぜあなたのPull Requestは読まれないのか - Cookiecutter Data Science