ArtifactCollection

class ArtifactCollection

(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
name: 'str',
type: 'str',
organization: 'str | None' = None,
attrs: 'ArtifactCollectionFragment | None' = None)

Description

An artifact collection that represents a group of related artifacts.

Args

• service_api: Interface to the wandb-core service that performs W&B API calls for this collection.
• entity: The entity (user or team) that owns the project.
• project: The name of the project to query for artifact collections.
• name: The name of the artifact collection.
• type: The type of the artifact collection (e.g., “dataset”, “model”).
• organization: Optional organization name if applicable.
• attrs: Optional mapping of attributes to initialize the artifact collection. If not provided, the object will load its attributes from W&B upon initialization.

Properties

property id

The unique identifier of the artifact collection.

property entity

The entity (user or team) that owns the project.

property project

The project that contains the artifact collection.

property aliases

The aliases for all artifact versions contained in this collection.

property created_at

The creation date of the artifact collection.

property updated_at

The date at which the artifact collection was last updated.

property description

A description of the artifact collection.

property tags

The tags associated with the artifact collection.

property name

The name of the artifact collection.

property type

Returns the type of the artifact collection.

Methods

method artifacts

self,
per_page: 'int' = 50,
start: 'str | None' = None

Get all artifacts in the collection.

Arguments

• per_page: The number of artifacts to fetch per page.
• start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

method change_type

self,
new_type: 'str'

Deprecated, change type directly with save instead.

Arguments

• new_type:

method delete

self

Delete the entire artifact collection.

method is_sequence

self

Return whether the artifact collection is a sequence.

method save

self

Persist any changes made to the artifact collection.