Rails アプリ地図考 Flush Cut

Slide 1

Slide 1 text

Rails アプリ地図考 Flush Cut @makicamel Omotesando.rb #106 スポンサー LT 2025.02.06

Slide 2

Slide 2 text

自己紹介 @makicamel / 川原万季 Ruby とビールとお酒が好き好きな言葉は「エイってやってバーン」㈱アンドパッド

Slide 3

Slide 3 text

東京 Ruby 会議 12 　　https://regional.rubykaigi.org/tokyo12

Slide 4

Slide 4 text

東京 Ruby 会議 12 楽しかったですね!

Slide 5

Slide 5 text

東京 Ruby 会議 12 前夜祭でトークもさせてもらいました https://regional.rubykaigi.org/tokyo12/talks

Slide 6

Slide 6 text

東京 Ruby 会議 12 今日はこのトークの LT 版 https://regional.rubykaigi.org/tokyo12/talks

Slide 7

Slide 7 text

東京 Ruby 会議 12 気になった方は元資料を見たり懇親会で声をかけてもらえると嬉しいです　　https://speakerdeck.com/makicamel/thinking-about-a-map-for-rails-applications

Slide 8

Slide 8 text

「地図」

Slide 9

Slide 9 text

地図株式会社アンドパッド秋葉原オフィスに初めて来た人地図を見てきましたね

Slide 10

Slide 10 text

地図道しるべ[^1] [^1]: もちろんそれ以外のたくさんの役割があります

Slide 11

Slide 11 text

Rails アプリの地図アプリを歩くための道しるべがほしい

Slide 12

Slide 12 text

Rails アプリの地図道しるべがないと　新しいメンバーオンボーディングで教わる以外のアプリの知識の獲得は手探り　慣れたメンバー普段触るサービスにアプリの知識が閉じがちいつの間にか知らないドメインが増えている

Slide 13

Slide 13 text

Rails アプリの地図といえば ER 図

Slide 14

Slide 14 text

Rails アプリの地図全 ER 図

Slide 15

Slide 15 text

Rails アプリの地図主要 ER 図の手動メンテ

Slide 16

Slide 16 text

つくった　　https://github.com/makicamel/erd_map

Slide 17

Slide 17 text

地図 https://www.google.com/maps ズームインすると詳細が見えるズームアウトすると全体が見通せる

Slide 18

Slide 18 text

ErdMap https://github.com/makicamel/erd_map ズームインすると詳細が見えるズームアウトすると概要が見える

Slide 19

Slide 19 text

ErdMap 最初は 3 つの"重要"なモデルのみ表示ズームインすると次に重要なモデルを表示重要度の高いモデルは大きく、重要度の低いモデルは小さく表示モデルを"コミュニティ"ごとに色分け

Slide 20

Slide 20 text

ErdMap ErdMap づくりに必要なことモデルの"重要"度の評価 "コミュニティ"分割

Slide 21

Slide 21 text

ErdMap のつくり方

Slide 22

Slide 22 text

ネットワーク分析

Slide 23

Slide 23 text

ネットワーク分析ネットワークとはノード（点）とエッジ（線）で構成されるデータ構造 e.g. SNS のユーザー関係ノード: ユーザー、エッジ: フォロー関係

Slide 24

Slide 24 text

ネットワーク分析 Rails アプリをひとつのネットワークとして捉えるノード: モデルエッジ: 関連

Slide 25

Slide 25 text

ErdMap に必要なことモデルの"重要"度の評価 "コミュニティ"分割

Slide 26

Slide 26 text

重要度の評価指標次数中心性固有ベクトル中心性媒介中心性 etc

Slide 27

Slide 27 text

重要度の評価指標: 次数中心性直接関連している他モデルの数（次数）を評価シンプルで高速

Slide 28

Slide 28 text

重要度の評価指標: 固有ベクトル中心性どれだけ重要なモデルと関連しているか[^2]を評価次数中心性の「数」の評価に対し「質」を評価 e.g. 請求データユーザーや注文といった中核モデルと紐づくため固有ベクトル中心性が高い紐づくモデルが少ないため次数中心性が低い e.g. 履歴データ中核モデルと紐づいても関連の終端になりやすく固有ベクトル中心性が低い多数の関連を持つため次数中心性が高い [^2]: 関連する重要モデルの数ではなく相手モデルのスコアの合計

Slide 29

Slide 29 text

重要度の評価指標: 媒介中心性他のモデル間の最短経路にどれだけ頻繁に登場するかを評価 e.g. 請求データユーザーや注文といった中核モデルと紐づくため固有ベクトル中心性が高い他のノード間の最短経路にあまり登場しないため媒介中心性が低い

Slide 30

Slide 30 text

固有ベクトル中心性のアルゴリズム

Slide 31

Slide 31 text

固有ベクトル中心性のアルゴリズム初期化すべてのノードに初期スコアを与える 1. スコアの更新各ノードのスコアの「接続先ノードのスコアの合計」を算出し正規化する 2. 繰り返しスコアが収束するまで 2 の計算を繰り返す 3.

Slide 32

Slide 32 text

固有ベクトル中心性のアルゴリズム例えば「A-B」「A-C」が接続するネットワークで考えてみる

Slide 33

Slide 33 text

固有ベクトル中心性のアルゴリズム 1. スコアの初期化 2. スコアの更新スコアの算出 → 正規化

Slide 34

Slide 34 text

固有ベクトル中心性のアルゴリズム 3. スコアの更新の繰り返し

Slide 35

Slide 35 text

固有ベクトル中心性のアルゴリズムスコアの更新を繰り返すとスコアがほとんど変化しなくなり最終的に収束する

Slide 36

Slide 36 text

ErdMap に必要なことモデルの"重要"度の評価 "コミュニティ"分割

Slide 37

Slide 37 text

コミュニティ分割とは？

Slide 38

Slide 38 text

コミュニティ分割重要なモデルとそれに関連するモデルを知りたいひとつのモデルはひとつの概念を表すビジネスロジックは複数のモデルから成ることが多い

Slide 39

Slide 39 text

コミュニティ分割 Mastdon の Account モデルの隣接モデル情報が多くて情報を読み取りづらい我々はもっと細かい単位で概念を認識しているはず

Slide 40

Slide 40 text

コミュニティ分割 Mastdon のモデルの Account モデルが所属するコミュニティ Accountにまつわる概念が抽出されていそう

Slide 41

Slide 41 text

コミュニティ分割モデルのグループをいい感じに分割して可視化したい

Slide 42

Slide 42 text

コミュニティ検出アルゴリズム Louvain 法 Girvan-Newman 法[^3] etc [^3]: Louvain法は高速、Girvan-Newman法は計算コストが高いですが、 Railsアプリのモデルデータくらいなら関係なさそうです

Slide 43

Slide 43 text

コミュニティ検出: Louvain 法ネットワーク内でつながりの強いコミュニティを発見するアルゴリズムモジュラリティを最大化するようノードを移動・統合し、最適化を繰り返すことで自然なまとまりに分割するモジュラリティ = つながりの密度

Slide 44

Slide 44 text

コミュニティ検出: Louvain 法 6つのノード、7つのエッジを持つネットワークがあるとする初期状態ではすべてのノードは独立したコミュニティ

Slide 45

Slide 45 text

コミュニティ検出: Louvain 法複数のノードを同じコミュニティにした場合のモジュラリティの変化を見てモジュラリティが高くなるノードグループをコミュニティとして確定する

Slide 46

Slide 46 text

コミュニティ検出: Louvain 法この操作を繰り返すと以下のコミュニティに分割される

Slide 47

Slide 47 text

実装自分で実装しなくていい NetworkX が提供するメソッドをコールするだけ

Slide 48

Slide 48 text

NetworkX ネットワーク分析用パッケージ Python 製 Rails から呼びたい　　NetworkX 　https://github.com/networkx/networkx

Slide 49

Slide 49 text

PyCall.rb Ruby - Python ブリッジライブラリ Python オブジェクトを Ruby から触れる Ruby オブジェクトを Python 側に見せられる mrknさん作　　PyCall 　https://github.com/mrkn/pycall.rb 　　PyCall があれば Ruby で機械学習ができる　https://magazine.rubyist.net/articles/0055/0055-pycall.html

Slide 50

Slide 50 text

固有ベクトル中心性 networkx = PyCall.import_module("networkx") graph = networkx.Graph.new # ... graphにノードやエッジを追加 ... centralities = networkx.eigenvector_centrality(graph) # => {ノード名: 中心性} のハッシュが返るこれだけのコードで固有ベクトル中心性が得られる

Slide 51

Slide 51 text

Louvain 法 whole_communities = networkx_community .louvain_communities(whole_graph) .map { |communities| PyCall::List.new(communities).to_a } これだけのコードで Louvain 法でコミュニティ分割できる

Slide 52

Slide 52 text

ErdMap デモ（Redmine の ErdMap）　　Redmine 　https://github.com/redmine/redmine 　　Sample HTML 　https://github.com/makicamel/erd_map/blob/main/sample/redmine.html

Slide 53

Slide 53 text

ErdMap を使ってみて

Slide 54

Slide 54 text

ErdMap 初見の小規模アプリ（モデル数 100）の場合重要な概念がわかるアプリの機能や構造・データフローのイメージが湧く

Slide 55

Slide 55 text

ErdMap 触り慣れている中規模アプリ（モデル数 1,400）の場合発見が多い最近こんなモデルが作られていたのか、とか気になっていたあのモデルはこういうものだったのか、とかあのサービスの主要モデルの関連はこうなっているのか、とか

Slide 56

Slide 56 text

ErdMap 楽並列に並ぶファイル名から概念や構造を見出すのは困難重みづけされグルーピングされて可視化されているとかんたん発見がある最新の状態の簡易的な ER 図がいつでもそこにある可視化面白い見えるようにすると何かが見える（かも）設計の改善点、ボトルネック...

Slide 57

Slide 57 text

Rails アプリの地図ぜひ試してみてください https://github.com/makicamel/erd_map