Annotate collections ↗

Documentation Index#

Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt Use this file to discover all available pages before exploring further.

Add human-friendly text to your collections to help users understand the purpose of the collection and the artifacts it contains.

Depending on the collection, you might want to include information about the training data, model architecture, task, license, references, and deployment. The proceeding lists some topics worth documenting in a collection:

W&B recommends including at minimum these details:

• Summary: The purpose of the collection. The machine learning framework used for the machine learning experiment.
• License: The legal terms and permissions associated with the use of the machine learning model. It helps model users understand the legal framework under which they can utilize the model. Common licenses include Apache 2.0, MIT, and GPL.
• References: Citations or references to relevant research papers, datasets, or external resources.

If your collection contains training data, consider including these additional details:

• Training data: Describe the training data used
• Processing: Processing done on the training data set.
• Data storage: Where is that data stored and how to access it.

If your collection contains a machine learning model, consider including these additional details:

• Architecture: Information about the model architecture, layers, and any specific design choices.
• Task: The specific type of task or problem that the machine that the collection model is designed to perform. It’s a categorization of the model’s intended capability.
• Deserialize the model: Provide information on how someone on your team can load the model into memory.
• Deployment: Details on how and where the model is deployed and guidance on how the model is integrated into other enterprise systems, such as a workflow orchestration platforms.

Add a description to a collection#

Interactively or programmatically add a description to a collection with the W&B Registry UI or Python SDK.

1. Navigate to the W&B Registry.
2. Click on a collection.
3. Select View details next to the name of the collection.
4. Within the Description field, provide information about your collection. Format text within with Markdown markup language.

Use the wandb.Api().artifact_collection() method to access a collection’s description. Use the returned object’s description property to add, or update, a description to the collection.

Specify the collection’s type for the type_name parameter and the collection’s full name for the name parameter. A collection’s name consists of the prefix “wandb-registry”, the name of the registry, and the name of the collection separated by a forward slashes:

    wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}
    ```

Copy and paste the following code snippet into your Python script or notebook. Replace values enclosed in angle brackets (`<>`) with your own.

```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()  
    ```
  <span class="tab-end"></span>
<span class="tab-group-end"></span>

For example, the proceeding image shows a collection that documents a model's architecture, intended use, performance information and more.


  <img src="https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=b793831adb9f0e4b51f7b4a19a9285dc" alt="Collection card" data-og-width="2520" width="2520" data-og-height="3136" height="3136" data-path="images/registry/registry_card.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?w=280&fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=6f6847353cd5c07adf3c562e452580b1 280w, https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?w=560&fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=3e0b2bb620d3642eea3c32b89757aa92 560w, https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?w=840&fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=c562f381d6370f78107d00ab6e0ee225 840w, https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?w=1100&fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=1f70174b5faba67d840c04d9bc87106d 1100w, https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?w=1650&fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=0095a41d9cd0588535adbc2846a5d990 1650w, https://mintcdn.com/wb-21fd5541/uqPGOvf46GQ1vVUB/images/registry/registry_card.png?w=2500&fit=max&auto=format&n=uqPGOvf46GQ1vVUB&q=85&s=f18456954a003f9cfc2c1244533cb822 2500w" />