Skip to main content

​
aliases

List of one or more semantically-friendly references or identifying “nicknames” assigned to an artifact version. Aliases are mutable references that you can programmatically reference. Change an artifact’s alias with the W&B App UI or programmatically. See Create new artifact versions for more information.

​
collection

The collection this artifact is retrieved from. A collection is an ordered group of artifact versions. If this artifact is retrieved from a collection that it is linked to, return that collection. Otherwise, return the collection that the artifact version originates from. The collection that an artifact originates from is known as the source sequence.

​
commit_hash

The hash returned when this artifact was committed.

​
created_at

Timestamp when the artifact was created.

​
description

A description of the artifact.

​
digest

The logical digest of the artifact. The digest is the checksum of the artifact’s contents. If an artifact has the same digest as the current latest version, then log_artifact is a no-op.

​
entity

The name of the entity that the artifact collection belongs to. If the artifact is a link, the entity will be the entity of the linked artifact.

​
file_count

The number of files (including references).

​
history_step

The nearest step which logged history metrics for this artifact’s source run.

​
id

The artifact’s ID. Boolean flag indicating if the artifact is a link artifact. True: The artifact is a link artifact to a source artifact. False: The artifact is a source artifact.

​
linked_artifacts

Returns a list of all the linked artifacts of a source artifact. If this artifact is a link artifact (artifact.is_link == True), it will return an empty list. Limited to 500 results.

​
manifest

The artifact’s manifest. The manifest lists all of its contents, and can’t be changed once the artifact has been logged.

​
metadata

User-defined artifact metadata. Structured data associated with the artifact.

​
name

The artifact name and version of the artifact. A string with the format {collection}:{alias}. If fetched before an artifact is logged/saved, the name won’t contain the alias. If the artifact is a link, the name will be the name of the linked artifact.

​
project

The name of the project that the artifact collection belongs to. If the artifact is a link, the project will be the project of the linked artifact.

​
qualified_name

The entity/project/name of the artifact. If the artifact is a link, the qualified name will be the qualified name of the linked artifact path.

​
size

The total size of the artifact in bytes. Includes any references tracked by this artifact.

​
source_artifact

Returns the source artifact, which is the original logged artifact. If this artifact is a source artifact (artifact.is_link == False), it will return itself.

​
source_collection

The artifact’s source collection. The source collection is the collection that the artifact was logged from.

​
source_entity

The name of the entity of the source artifact.

​
source_name

The artifact name and version of the source artifact. A string with the format {source_collection}:{alias}. Before the artifact is saved, contains only the name since the version is not yet known.

​
source_project

The name of the project of the source artifact.

​
source_qualified_name

The source_entity/source_project/source_name of the source artifact.

​
source_version

The source artifact’s version. A string with the format v{number}.

​
state

The status of the artifact. One of: “PENDING”, “COMMITTED”, or “DELETED”.

​
tags

List of one or more tags assigned to this artifact version.

​
ttl

The time-to-live (TTL) policy of an artifact. Artifacts are deleted shortly after a TTL policy’s duration passes. If set to None, the artifact deactivates TTL policies and will be not scheduled for deletion, even if there is a team default TTL. An artifact inherits a TTL policy from the team default if the team administrator defines a default TTL and there is no custom policy set on an artifact.

​
type

The artifact’s type. Common types include dataset or model.

​
updated_at

The time when the artifact was last updated.

​
url

Constructs the URL of the artifact.

​
use_as

Deprecated.

​
version

The artifact’s version. A string with the format v{number}. If this is a link artifact, the version will be from the linked collection.