Skip to main content

​
class ArtifactCollection

​
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.

​
Properties

​
property aliases

The aliases for all artifact versions contained in this collection.

​
property created_at

The creation date of the artifact collection.

​
property description

A description of the artifact collection.

​
property entity

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

​
property id

The unique identifier of the artifact collection.

​
property name

The name of the artifact collection.

​
property project

The project that contains the artifact collection.

​
property tags

The tags associated with the artifact collection.

​
property type

Returns the type of the artifact collection.

​
property updated_at

The date at which the artifact collection was last updated.

​
Methods

​
method ArtifactCollection.artifacts()

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 ArtifactCollection.change_type()

Deprecated, change type directly with save instead.
Arguments
  • new_type:

​
method ArtifactCollection.delete()

Delete the entire artifact collection.

​
method ArtifactCollection.is_sequence()

Return whether the artifact collection is a sequence.

​
method ArtifactCollection.save()

Persist any changes made to the artifact collection.