Document machine learning model

モデルカード に説明を追加して、 モデル を文書化します。

登録済みモデルのモデルカードに説明を追加して、 機械学習 モデルの側面を文書化します。文書化する価値のあるトピックには、次のものがあります。

  • 概要: モデルの概要。モデルの目的。モデルが使用する 機械学習 フレームワークなど。
  • トレーニングデータ: 使用したトレーニングデータ、トレーニングデータセットで実行された処理、そのデータの保存場所などを記述します。
  • アーキテクチャー: モデルアーキテクチャー、レイヤー、および特定の設計の選択に関する情報。
  • モデルのデシリアライズ: チームの誰かがモデルをメモリーにロードする方法に関する情報を提供します。
  • タスク: 機械学習 モデルが実行するように設計されている特定のタイプのタスクまたは問題。モデルの意図された機能の分類です。
  • ライセンス: 機械学習 モデルの使用に関連する法的条件と許可。モデル ユーザーがモデルを利用できる法的枠組みを理解するのに役立ちます。
  • 参考文献: 関連する 研究 論文、データセット、または外部リソースへの引用または参考文献。
  • デプロイメント: モデルのデプロイ方法と場所の詳細、および ワークフロー オーケストレーション プラットフォーム などの他のエンタープライズ システムへのモデルの統合方法に関するガイダンス。

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

  1. https://wandb.ai/registry/model にある W&B Model Registry アプリケーションに移動します。
  2. モデルカードを作成する登録済みモデルの名前の横にある [詳細を表示] を選択します。
  3. [モデルカード] セクションに移動します。
  4. [説明] フィールドに、 機械学習 モデルに関する情報を提供します。Markdown マークアップ言語を使用して、モデルカード内のテキストの書式を設定します。

たとえば、次の図は、Credit-card Default Prediction 登録済みモデルのモデルカードを示しています。