> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-feat-cli-docs-generator.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# コレクションに注釈を付ける
コレクションに人間が理解しやすいテキストを追加して、ユーザーがコレクションの目的とその中に含まれるアーティファクトを理解するのを助けます。
コレクションに応じて、トレーニングデータ、モデルアーキテクチャー、タスク、ライセンス、参考文献、デプロイメントに関する情報を含めることをお勧めします。以下は、コレクションで文書化する価値のあるトピックのリストです。
W\&Bは少なくともこれらの詳細を含めることを推奨します。
* **概要**: コレクションの目的。機械学習実験に使用された機械学習フレームワーク。
* **ライセンス**: 機械学習モデルの使用に関連する法的条件と許可。モデルのユーザーがどの法的枠組みの下でモデルを利用できるかを理解するのに役立ちます。一般的なライセンスには、Apache 2.0、MIT、GPL などがあります。
* **参考文献**: 関連する研究論文、データセット、または外部リソースへの引用または参考文献。
コレクションにトレーニングデータが含まれている場合は、以下の詳細を考慮してください。
* **トレーニングデータ**: 使用したトレーニングデータの説明
* **プロセッシング**: トレーニングデータセットに対して行われたプロセッシング。
* **データストレージ**: そのデータがどこに保存されていて、どのようにアクセスするか。
コレクションに機械学習モデルが含まれている場合は、以下の詳細を考慮してください。
* **アーキテクチャー**: モデルのアーキテクチャー、レイヤー、および特定のデザイン選択に関する情報。
* **タスク**: コレクションモデルが実行するように設計された特定のタスクまたは問題の種類。モデルの意図された能力のカテゴリ分けです。
* **モデルをデシリアライズ**: あなたのチームの誰かがモデルをメモリにロードする方法に関する情報を提供してください。
* **タスク**: 機械学習モデルが実行するように設計された特定のタスクまたは問題の種類。モデルの意図された能力のカテゴリ分けです。
* **デプロイメント**: モデルがどのように、どこでデプロイされるかに関する詳細、およびワークフローのオーケストレーションプラットフォームなどの他の企業システムにモデルを統合する方法に関するガイダンス。
## コレクションに説明を追加する
W\&B Registry UIまたはPython SDKを使用して、インタラクティブまたはプログラム的にコレクションに説明を追加します。
1. [https://wandb.ai/registry/](https://wandb.ai/registry/)でW\&B Registryにアクセスします。
2. コレクションをクリックします。
3. コレクション名の横にある**詳細を表示**を選択します。
4. **説明**フィールド内で、コレクションに関する情報を提供します。[Markdownマークアップ言語](https://www.markdownguide.org/)でテキストをフォーマットします。
[`wandb.Api().artifact_collection()`](/ja/models/ref/python/public-api/api#artifact_collection) メソッドを使用してコレクションの説明にアクセスします。返されたオブジェクトの `description` プロパティを使用してコレクションに説明を追加または更新します。
`type_name`パラメータにはコレクションのタイプを、`name`パラメータにはコレクションの完全な名前を指定します。コレクションの名前は「wandb-registry」、レジストリの名前、およびコレクションの名前をスラッシュで区切ったものです:
```text theme={null}
wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}
```
以下のコードスニペットをあなたのPythonスクリプトまたはノートブックにコピーペーストします。角括弧で囲まれた値 (`<>`) をあなた独自のものに置き換えてください。
```python theme={null}
import wandb
api = wandb.Api()
collection = api.artifact_collection(
type_name = "",
name = ""
)
collection.description = "This is a description."
collection.save()
```
例えば、以下の画像は、モデルのアーキテクチャー、意図された使用法、パフォーマンス情報などをドキュメントしているコレクションを示しています。
