Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
ドキュメンテーションのすヽめ_#MLbeginners
Search
ninohira
October 27, 2019
Technology
1
670
ドキュメンテーションのすヽめ_#MLbeginners
ML for Beginners! MeetUp登壇資料
#MLbeginners
ninohira
October 27, 2019
Tweet
Share
More Decks by ninohira
See All by ninohira
[ICML2021 論文読み会]Revisiting Rainbow: Promoting more Insightful and Inclusive Deep Reinforcement Learning Research
ninohira
0
1.4k
[論文紹介]Jukebox: A Generative Model for Music
ninohira
0
640
無駄分析を避ける為にデータサイエンティストに求められる能力
ninohira
3
12k
アーティストにとっての「愛」とは?~What is ”Love" for artist?~
ninohira
1
9.8k
Data Gateway Talk Vol.5運営資料
ninohira
1
480
今再びのRによる因果推論_Causal Interference by R_#japanr
ninohira
2
10k
因果推論の基礎とその罠 _Basic and Trap of Causal Inference_#白金鉱業
ninohira
5
12k
Data Gateway Talk Vol.1運営資料
ninohira
1
3k
新卒が考えた理想のDS新卒研修
ninohira
1
760
Other Decks in Technology
See All in Technology
ドメインの本質を掴む / Get the essence of the domain
sinsoku
2
160
適材適所の技術選定 〜GraphQL・REST API・tRPC〜 / Optimal Technology Selection
kakehashi
1
690
初心者向けAWS Securityの勉強会mini Security-JAWSを9ヶ月ぐらい実施してきての近況
cmusudakeisuke
0
130
Platform Engineering for Software Developers and Architects
syntasso
1
520
組織成長を加速させるオンボーディングの取り組み
sudoakiy
2
210
インフラとバックエンドとフロントエンドをくまなく調べて遅いアプリを早くした件
tubone24
1
430
The Role of Developer Relations in AI Product Success.
giftojabu1
0
140
OCI Vault 概要
oracle4engineer
PRO
0
9.7k
OCI 運用監視サービス 概要
oracle4engineer
PRO
0
4.8k
Application Development WG Intro at AppDeveloperCon
salaboy
0
190
100 名超が参加した日経グループ横断の競技型 AWS 学習イベント「Nikkei Group AWS GameDay」の紹介/mediajaws202411
nikkei_engineer_recruiting
1
170
飲食店データの分析事例とそれを支えるデータ基盤
kimujun
0
160
Featured
See All Featured
The Art of Programming - Codeland 2020
erikaheidi
52
13k
Documentation Writing (for coders)
carmenintech
65
4.4k
Learning to Love Humans: Emotional Interface Design
aarron
273
40k
It's Worth the Effort
3n
183
27k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
6
430
Measuring & Analyzing Core Web Vitals
bluesmoon
4
130
Optimising Largest Contentful Paint
csswizardry
33
2.9k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
28
9.1k
What's in a price? How to price your products and services
michaelherold
243
12k
jQuery: Nuts, Bolts and Bling
dougneiner
61
7.5k
Building Applications with DynamoDB
mza
90
6.1k
The Cost Of JavaScript in 2023
addyosmani
45
6.8k
Transcript
υΩϡϝϯςʔγϣϯͷ͢ʍΊ Recommend to Documentation
Recommend to Documentation 免責事項 / お願い - 本登壇は個⼈の⾒解であり、所属する組織の公式⾒解ではありません - 社会⼈2年⽬のビギナーなので優しい⽬で⾒てください
-「お気持ち」的な内容がメインになります - 受託分析データサイエンティスト視点なので、多少バイアスがあります - ツイッターにたくさんつぶやくと運営&⾃分が喜びますので、たくさんツイートしてください 2/14
Recommend to Documentation 質問 ドキュメンテーション⼤切だと感じたことある⽅︕︕ (深掘り) いつ / どうして そう思ったかを
考えました︖ 「誰か」に「何か」を伝えることって⼤切
Recommend to Documentation ⾃⼰紹介 学⽣ 早稲⽥⼤学 創造理⼯学研究科 経営システム⼯学専攻 共同研究先のマーケティングデータ ×
データサイエンス 仕事 データサイエンティスト @BrainPad 2018年新卒 強化学習 / NLP / 統計的因果推論 / 画像異常検知 趣味 仁ノ平 将⼈ Masato Ninohira (@nino_pira) Data Gateway Talk 主催 B’zファン(⾳楽×データ分析のイベント企画now) ブログ︓データサイエンティスト⾒習いの⽇常 フットサル 4/14
Recommend to Documentation ⽬次 - Why Documentation? - ドキュメントの分類 -
コード / 分析レポート - まとめ 5/14
Recommend to Documentation ⾃分の記憶の共有 = 不可能 Why Documentation︖ Impossible to
SHARE Brain 「誰か」に「何か」を伝えたい Idea ケースに応じたドキュメンテーション Want to SHARE Idea SHARE by Document SHARE 6/14
Recommend to Documentation ドキュメントの分類 ※MECEではないです。作為的に⽊を切っています ※「メール / 議事録」も考えましたが、分析内容を 直接書くことは稀だと思いましたのでスコープ外 Who
- 分析チーム - 意思決定者 - コンピュータ - 分析結果 / next アクション - 意思決定者への レポートに必要な素材選定 - ⾃分のコードの確認 - 分析の結果を正しく伝え、意思決定のサポート - 回るコード / 早いコード - 分析レポート - コード - 分析レポート What Document - コード 「誰」に「何を伝えたいか」の構造化が良いドキュメント化へのポイント 7/14
Recommend to Documentation コード コンピュータ & ⼈間に読みやすいコード 計算速度 冗⻑なコードの回避 例︓
組み込み関数のsumを使う 可読性の⾼い実装 - 明瞭なディレクトリ構成 - コーディング規約 /適切なコメント - 明瞭なプルリク 8/14
Recommend to Documentation 参考︓ ディレクトリ構造のテンプレ ⾃分はこれに⾃分専⽤の 開発環境特化素材を加えてる (例︓Docker) 9/14
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
Recommend to Documentation 参考︓コンフルエンスを⽤いた分析レポート作成 オンラインで共有 = 情報の共有の閾値が低 (全ての実験結果をコンフルに記載) 11/14
Recommend to Documentation 参考︓分析レポート以外の記事もたくさん書いてます 12/14
Recommend to Documentation 参考︓どう鍛えるの︖ 意識して経験するしかないと思っています。。。 Do Best Every Time ※むしろ良い⽅法をご存知の⽅教えてください、、、
13/14
Recommend to Documentation まとめ - 情報の伝達⼿段としてドキュメンテーションは有効 - 「誰」に「何を」伝えたいかの「構造化」を意識したドキュメント化 14/14
Recommend to Documentation 参考⽂献 - はじめてのNoteと、ドキュメンテーションについて (本登壇はこの資料に超影響を受けてます) - 1分で話せ 世界のトップが絶賛した⼤事なことだけシンプルに伝える技術
- イシューからはじめよ 知的⽣産の「シンプルな本質」 - なぜあなたのPull Requestは読まれないのか - Cookiecutter Data Science