コレクションに注釈を追加する

コレクションにユーザーが理解しやすいテキストを追加して、そのコレクションと、そこに含まれるアーティファクトの目的を説明します。

コレクションの内容に応じて、学習データ、モデルアーキテクチャ、タスク、ライセンス、参考文献、デプロイに関する情報を含めるとよいでしょう。以下に、コレクション内で文書化しておくと有用なトピックを挙げます。

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 マークアップ言語を使ってテキストを整形できます。

Python SDK

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

type_name パラメータにはコレクションのタイプを、name パラメータにはコレクションの完全な名前を指定します。コレクションの名前は、接頭辞 “wandb-registry”、レジストリ名、およびコレクション名をスラッシュ（/）で区切って構成されます:

wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}

次のコードスニペットを Python スクリプトまたはノートブックにコピー＆ペーストします。山かっこ（<>）で囲まれた値をご自身の値に置き換えてください。

import wandb

api = wandb.Api()

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


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

たとえば、次の画像は、モデルのアーキテクチャ、想定される用途、性能情報などをドキュメント化したコレクションを示しています。