機械学習モデルのドキュメント化

登録されたモデルのモデルカードに説明を追加して、機械学習モデルの各側面をドキュメント化します。ドキュメント化する価値のあるトピックには以下が含まれます。

• Summary: モデルが何であるかの概要。モデルの目的。モデルが使用する機械学習フレームワークなど。
• Training data: 使用されたトレーニングデータの説明、トレーニングデータセットに対して行われたプロセッシング、そのデータがどこに保存されているかなど。
• Architecture: モデルのアーキテクチャー、レイヤー、および特定の設計選択に関する情報。
• Deserialize the model: チーム内の誰かがモデルをメモリにロードできる方法の情報を提供します。
• Task: 機械学習モデルが設計された特定のタスクや問題。これはモデルの意図された能力の分類です。
• License: 機械学習モデルの使用に関連する法的条件および許可。これはモデルユーザーがモデルを利用する際の法的フレームワークを理解するのに役立ちます。
• References: 関連する研究論文、データセット、または外部リソースへの引用や参照。
• Deployment: モデルがどのように、そしてどこでデプロイされるのか、またワークフローオーケストレーションプラットフォームなどの他の企業システムにモデルがどのように統合されるのかに関するガイドライン。

モデルカードに説明を追加する

1. W&B Model Registry アプリに移動します https://wandb.ai/registry/model.
2. モデルカードを作成したい登録済みモデルの名前の横にある View details を選択します。
3. Model card セクションに移動します。
4. Description フィールド内に機械学習モデルに関する情報を提供します。モデルカード内のテキストは Markdown マークアップ言語 でフォーマットします。

例えば、以下の画像は Credit-card Default Prediction 登録モデルのモデルカードを示しています。