> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-automation-updates-docs-2928-docs-2829.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# コレクションに説明を追加する
> W&B Registry のコレクションに説明やドキュメントを追加して、ユーザーがその目的と内容を理解できるようにします。
コレクションの目的や含まれる アーティファクト をユーザーが理解しやすいように、コレクションにわかりやすい説明文を追加します。
コレクションによっては、トレーニングデータ、モデルアーキテクチャ、タスク、ライセンス、参考文献、デプロイに関する情報を含めるとよいでしょう。以下に、コレクションに記載しておくとよいトピックをいくつか示します。
W\&B では、少なくとも次の項目を含めることを推奨します。
* **Summary**: コレクションの目的、および機械学習の実験で使用した機械学習フレームワーク。
* **License**: 機械学習モデルの使用に関する法的条件と権限。これにより、モデルのユーザーは、そのモデルをどのような法的枠組みのもとで利用できるかを理解できます。一般的なライセンスには、Apache 2.0、MIT、GPL があります。
* **References**: 関連する研究論文、データセット、または外部リソースへの引用や参照。
コレクションにトレーニングデータが含まれている場合は、次の追加情報を含めることを検討してください。
* **Training data**: 使用したトレーニングデータを説明します。
* **Processing**: トレーニングデータセットに対して実施した処理。
* **Data storage**: そのデータの保存場所とアクセス方法。
コレクションに機械学習モデルが含まれている場合は、次の追加情報を含めることを検討してください。
* **Architecture**: モデルアーキテクチャ、レイヤー、および特定の設計上の選択に関する情報。
* **Task**: コレクション内のモデルが実行するよう設計されている、具体的なタスクまたは問題のタイプ。これは、モデルが意図する機能の分類です。
* **Deserialize the model**: チーム内のユーザーがそのモデルをメモリに読み込む方法に関する情報。
* **Deployment**: モデルがどのように、どこにデプロイされているかの詳細と、ワークフローオーケストレーションプラットフォームなどの他のエンタープライズシステムにモデルをどのように統合しているかに関するガイダンス。
* **Compare metrics**: コレクションにリンクされた アーティファクト の異なるバージョン間でメトリクスを比較します。これにより、モデルが時間の経過とともにどのように進化したか、また異なるバージョンが特定のタスクでどのような性能を示すかをユーザーが理解しやすくなります。
## コレクション に説明を追加する
W\&B Registry UI または Python SDK を使用して、インタラクティブに、またはプログラムから コレクション に説明を追加します。
1. [W\&B Registry](https://wandb.ai/registry/) にアクセスします。
2. コレクション をクリックします。
3. コレクション の名の横にある **View details** を選択します。
4. **コレクションカード** タブを選択します。
5. **Edit card** ボタンをクリックします。
6. コレクションカードエディタ内で、コレクション に説明を追加します。Markdown 書式を使用してテキストのスタイルを設定できます。
テキストは [Markdown markup language](https://www.markdownguide.org/) を使用して書式設定します。使用可能な Markdown 書式オプションのドロップダウンリストを表示するには、スラッシュ (`/`) を使用します。
[`wandb.Api().artifact_collection()`](/ja/models/ref/python/public-api/api#artifact_collection) method を使用して、コレクション の説明にアクセスします。返されたオブジェクトの `description` プロパティを使用して、コレクション の説明を追加または更新します。
`type_name` パラメーターには コレクション のタイプを、`name` パラメーターには コレクション の完全名を指定します。コレクション の名は、接頭辞 “wandb-registry”、registry の名、コレクション の名をスラッシュで区切ったものです。
```text theme={null}
wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}
```
以下の code snippet を Python script or notebook にコピー＆ペーストします。山かっこ (`<>`) で囲まれた値は、ご自身の値に置き換えてください。
```python theme={null}
import wandb
api = wandb.Api()
collection = api.artifact_collection(
type_name = "",
name = ""
)
collection.description = "This is a description."
collection.save()
```
## アーティファクト のバージョン間でメトリクスを比較する
コレクションカードエディタでは、コレクションにリンクされた アーティファクト の異なるバージョン間でメトリクスを比較できます。
1. コレクションカードエディタで、スラッシュ (`/`) を入力して、使用可能な Markdown 書式オプションのドロップダウンリストを開きます。
2. **Compare metrics** を選択して、メトリクスの比較表をコレクションカードに追加します。
次の画像は、`transaction-risk-model` コレクションにリンクされた 5 つの異なる アーティファクト バージョンにまたがる `val/loss` を示しています。
