コレクションに説明を追加する

W&B Registry のコレクションに説明やドキュメントを追加して、ユーザーがその目的と内容を理解できるようにします。

コレクションの目的や含まれる Artifacts をユーザーが理解しやすいように、コレクションにわかりやすい説明文を追加します。

コレクションによっては、トレーニングデータ、モデルアーキテクチャ、タスク、ライセンス、参考文献、デプロイに関する情報を含めるとよいでしょう。以下に、コレクションに記載しておくとよいトピックをいくつか示します。

W&B では、少なくとも次の項目を含めることを推奨します。

• Summary: コレクションの目的、および機械学習の実験で使用した機械学習フレームワーク。
• License: 機械学習モデルの使用に関する法的条件と権限。これにより、モデルのユーザーは、そのモデルをどのような法的枠組みのもとで利用できるかを理解できます。一般的なライセンスには、Apache 2.0、MIT、GPL があります。
• References: 関連する研究論文、データセット、または外部リソースへの引用や参照。

コレクションにトレーニングデータが含まれている場合は、次の追加情報を含めることを検討してください。

• Training data: 使用したトレーニングデータを説明します。
• Processing: トレーニングデータセットに対して実施した処理。
• Data storage: そのデータの保存場所とアクセス方法。

コレクションに機械学習モデルが含まれている場合は、次の追加情報を含めることを検討してください。

• Architecture: モデルアーキテクチャ、レイヤー、および特定の設計上の選択に関する情報。
• Task: コレクション内のモデルが実行するよう設計されている、具体的なタスクまたは問題のタイプ。これは、モデルが意図する機能の分類です。
• Deserialize the model: チーム内のユーザーがそのモデルをメモリに読み込む方法に関する情報。
• Deployment: モデルがどのように、どこにデプロイされているかの詳細と、ワークフローオーケストレーションプラットフォームなどの他のエンタープライズシステムにモデルをどのように統合しているかに関するガイダンス。

​

コレクション に説明を追加する

W&B Registry UI または Python SDK を使用して、インタラクティブに、またはプログラムから コレクション に説明を追加します。

W&B Registry UI

1. W&B Registry にアクセスします。
2. コレクション をクリックします。
3. コレクション の名の横にある View details を選択します。
4. Description フィールドに コレクション に関する情報を入力します。テキストは Markdown markup language を使用して書式設定できます。

Python SDK

wandb.Api().artifact_collection() method を使用して、コレクション の説明にアクセスします。返されたオブジェクトの description プロパティを使用して、コレクション の説明を追加または更新します。

type_name パラメーターには コレクション のタイプを、name パラメーターには コレクション の完全名を指定します。コレクション の名は、接頭辞 “wandb-registry”、registry の名、コレクション の名をスラッシュで区切ったものです。

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

以下の code snippet を Python script or notebook にコピー＆ペーストします。山かっこ (<>) で囲まれた値は、ご自身の値に置き換えてください。

import wandb

api = wandb.Api()

collection = api.artifact_collection(
  type_name = "<collection_type>", 
  name = "<collection_name>"
  )


collection.description = "This is a description."
collection.save()  

たとえば、次の画像は、モデルのアーキテクチャ、想定される用途、パフォーマンス情報などを記載した コレクション を示しています。