Artifact

name: 'str',
type: 'str',
description: 'str | None' = None,
metadata: 'dict[str, Any] | None' = None,
incremental: 'bool' = False,
use_as: 'str | None' = None,
storage_region: 'str | None' = None

Description

Flexible and lightweight building block for dataset and model versioning.

Construct an empty W&B Artifact. Populate an artifacts contents with methods that begin with add. Once the artifact has all the desired files, you can call run.log_artifact() to log it.

Args

• name: A human-readable name for the artifact. Use the name to identify a specific artifact in the W&B App UI or programmatically. You can interactively reference an artifact with the use_artifact Public API. A name can contain letters, numbers, underscores, hyphens, and dots. The name must be unique across a project.
• type: The artifact’s type. Use the type of an artifact to both organize and differentiate artifacts. You can use any string that contains letters, numbers, underscores, hyphens, and dots. Common types include dataset or model. Include model within your type string if you want to link the artifact to the W&B Model Registry. Note that some types reserved for internal use and cannot be set by users. Such types include job and types that start with wandb-.
• description: A description of the artifact. For Model or Dataset Artifacts, add documentation for your standardized team model or dataset card. View an artifact’s description programmatically with the Artifact.description attribute or programmatically with the W&B App UI. W&B renders the description as markdown in the W&B App.
• metadata: Additional information about an artifact. Specify metadata as a dictionary of key-value pairs. You can specify no more than 100 total keys.
• incremental: Use Artifact.new_draft() method instead to modify an existing artifact.
• use_as: Deprecated.
• storage_region:

Properties

property id

The artifact’s ID.

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

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

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

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

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

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

property source_entity

The name of the entity of the source artifact.

property source_project

The name of the project of the source artifact.

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

property source_qualified_name

The source_entity/source_project/source_name of the source artifact.

property source_version

The source artifact’s version.

A string with the format v{number}.

property source_collection

The artifact’s source collection.

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

property is_link

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.

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

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

property type

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

property url

Constructs the URL of the artifact.

property description

A description of the artifact.

property metadata

User-defined artifact metadata.

Structured data associated with the artifact.

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

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

property tags

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

property use_as

Deprecated.

property state

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

property manifest

The artifact’s manifest.

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

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

property size

The total size of the artifact in bytes.

Includes any references tracked by this artifact.

property commit_hash

The hash returned when this artifact was committed.

property file_count

The number of files (including references).

property created_at

Timestamp when the artifact was created.

property updated_at

The time when the artifact was last updated.

property history_step

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

Methods

method add

self,
obj: 'WBValue',
name: 'StrPath',
overwrite: 'bool' = False

Add wandb.WBValue obj to the artifact.

Arguments

• obj: The object to add. Currently support one of Bokeh, JoinedTable, PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D, Audio, Image, Video, Html, Object3D
• name: The path within the artifact to add the object.
• overwrite: If True, overwrite existing objects with the same file path if applicable.

Raises

• ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead.

method add_dir

self,
local_path: 'str',
name: 'str | None' = None,
skip_cache: 'bool | None' = False,
policy: "Literal['mutable', 'immutable'] | None" = 'mutable',
merge: 'bool' = False

Add a local directory to the artifact.

Arguments

• local_path: The path of the local directory.
• name: The subdirectory name within an artifact. The name you specify appears in the W&B App UI nested by artifact’s type. Defaults to the root of the artifact.
• skip_cache: If set to True, W&B will not copy/move files to the cache while uploading
• policy: By default, “mutable”.
• merge: If False (default), throws ValueError if a file was already added in a previous add_dir call and its content has changed. If True, overwrites existing files with changed content. Always adds new files and never removes files. To replace an entire directory, pass a name when adding the directory using add_dir(local_path, name=my_prefix) and call remove(my_prefix) to remove the directory, then add it again.

Raises

• ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead.
• ValueError: Policy must be “mutable” or “immutable”

method add_file

self,
local_path: 'str',
name: 'str | None' = None,
is_tmp: 'bool | None' = False,
skip_cache: 'bool | None' = False,
policy: "Literal['mutable', 'immutable'] | None" = 'mutable',
overwrite: 'bool' = False

Add a local file to the artifact.

Arguments

• local_path: The path to the file being added.
• name: The path within the artifact to use for the file being added. Defaults to the basename of the file.
• is_tmp: If true, then the file is renamed deterministically to avoid collisions.
• skip_cache: If True, do not copy files to the cache after uploading.
• policy: By default, set to “mutable”. If set to “mutable”, create a temporary copy of the file to prevent corruption during upload. If set to “immutable”, disable protection and rely on the user not to delete or change the file.
• overwrite: If True, overwrite the file if it already exists.

Raises

• ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead.
• ValueError: Policy must be “mutable” or “immutable”

method add_reference

self,
uri: 'ArtifactManifestEntry | str',
name: 'StrPath | None' = None,
checksum: 'bool' = True,
max_objects: 'int | None' = None

Add a reference denoted by a URI to the artifact.

Unlike files or directories that you add to an artifact, references are not uploaded to W&B. For more information, see Track external files.

By default, the following schemes are supported:

• http(s): The size and digest of the file will be inferred by the Content-Length and the ETag response headers returned by the server.
• s3: The checksum and size are pulled from the object metadata. If bucket versioning is enabled, then the version ID is also tracked.
• gs: The checksum and size are pulled from the object metadata. If bucket versioning is enabled, then the version ID is also tracked.
• https, domain matching *.blob.core.windows.net
• Azure: The checksum and size are be pulled from the blob metadata. If storage account versioning is enabled, then the version ID is also tracked.
• file: The checksum and size are pulled from the file system. This scheme is useful if you have an NFS share or other externally mounted volume containing files you wish to track but not necessarily upload.

For any other scheme, the digest is just a hash of the URI and the size is left blank.

Arguments

• uri: The URI path of the reference to add. The URI path can be an object returned from Artifact.get_entry to store a reference to another artifact’s entry.
• name: The path within the artifact to place the contents of this reference.
• checksum: Whether or not to checksum the resource(s) located at the reference URI. Checksumming is strongly recommended as it enables automatic integrity validation. Disabling checksumming will speed up artifact creation but reference directories will not iterated through so the objects in the directory will not be saved to the artifact. We recommend setting checksum=False when adding reference objects, in which case a new version will only be created if the reference URI changes.
• max_objects: The maximum number of objects to consider when adding a reference that points to directory or bucket store prefix. By default, the maximum number of objects allowed for Amazon S3, GCS, Azure, and local files is 10,000,000. Other URI schemas do not have a maximum.

Raises

• ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead.

method checkout

self,
root: 'str | None' = None

Replace the specified root directory with the contents of the artifact.

WARNING: This will delete all files in root that are not included in the artifact.

Arguments

• root: The directory to replace with this artifact’s files.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method delete

self,
delete_aliases: 'bool' = False

Delete an artifact and its files.

If called on a linked artifact, only the link is deleted, and the source artifact is unaffected.

Use Artifact.unlink() instead of Artifact.delete() to remove a link between a source artifact and a collection.

Arguments

• delete_aliases: If set to True, delete all aliases associated with the artifact. If False, raise an exception if the artifact has existing aliases. This parameter is ignored if the artifact is retrieved from a collection it is linked to.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method download

self,
root: 'StrPath | None' = None,
allow_missing_references: 'bool' = False,
skip_cache: 'bool | None' = None,
path_prefix: 'StrPath | None' = None,
multipart: 'bool | None' = None

Download the contents of the artifact to the specified root directory.

Existing files located within root are not modified. Explicitly delete root before you call download if you want the contents of root to exactly match the artifact.

Arguments

• root: The directory W&B stores the artifact’s files.
• allow_missing_references: If set to True, any invalid reference paths will be ignored while downloading referenced files.
• skip_cache: If set to True, the artifact cache will be skipped when downloading and W&B will download each file into the default root or specified download directory.
• path_prefix: If specified, only files with a path that starts with the given prefix will be downloaded. Uses unix format (forward slashes).
• multipart: If set to None (default), the artifact will be downloaded in parallel using multipart download if individual file size is greater than 2GB. If set to True or False, the artifact will be downloaded in parallel or serially regardless of the file size.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method file

self,
root: 'str | None' = None

Download a single file artifact to the directory you specify with root.

Arguments

• root: The root directory to store the file. Defaults to ./artifacts/self.name/.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.
• ValueError: If the artifact contains more than one file.

method files

self,
names: 'list[str] | None' = None,
per_page: 'int' = 50,
start: 'str | None' = None

Iterate over all files stored in this artifact.

Arguments

• names: The filename paths relative to the root of the artifact you wish to list.
• per_page: The number of files to return per request.
• start: Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method finalize

self

Finalize the artifact version.

You cannot modify an artifact version once it is finalized because the artifact is logged as a specific artifact version. Create a new artifact version to log more data to an artifact. An artifact is automatically finalized when you log the artifact with log_artifact.

method get

self,
name: 'str'

Get the WBValue object located at the artifact relative name.

Arguments

• name: The artifact relative name to retrieve.

Raises

• ArtifactNotLoggedError: if the artifact isn’t logged or the run is offline.

method get_added_local_path_name

self,
local_path: 'str'

Get the artifact relative name of a file added by a local filesystem path.

Arguments

• local_path: The local path to resolve into an artifact relative name.

method get_entry

self,
name: 'StrPath'

Get the entry with the given name.

Arguments

• name: The artifact relative name to get

Raises

• ArtifactNotLoggedError: if the artifact isn’t logged or the run is offline.
• KeyError: if the artifact doesn’t contain an entry with the given name.

method get_path

self,
name: 'StrPath'

Deprecated. Use get_entry(name).

Arguments

• name:

method is_draft

self

Check if artifact is not saved.

method json_encode

self

Returns the artifact encoded to the JSON format.

method link

self,
target_path: 'str',
aliases: 'Iterable[str] | None' = None

Link this artifact to a collection.

Arguments

• target_path: The path of the collection. Path consists of the prefix “wandb-registry-” along with the registry name and the collection name wandb-registry-{REGISTRY_NAME}/{COLLECTION_NAME}.
• aliases: Add one or more aliases to the linked artifact. The “latest” alias is automatically applied to the most recent artifact you link.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method logged_by

self

Get the W&B run that originally logged the artifact.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method new_draft

self

Create a new draft artifact with the same content as this committed artifact.

Modifying an existing artifact creates a new artifact version known as an “incremental artifact”. The artifact returned can be extended or modified and logged as a new version.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method new_file

self,
name: 'str',
mode: 'str' = 'x',
encoding: 'str | None' = None

Open a new temporary file and add it to the artifact.

Arguments

• name: The name of the new file to add to the artifact.
• mode: The file access mode to use to open the new file.
• encoding: The encoding used to open the new file.

Raises

• ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead.

method remove

self,
item: 'StrPath | ArtifactManifestEntry'

Remove an item from the artifact.

Arguments

• item: The item to remove. Can be a specific manifest entry or the name of an artifact-relative path. If the item matches a directory all items in that directory will be removed.

Raises

• ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead.
• FileNotFoundError: If the item isn’t found in the artifact.

method save

self,
project: 'str | None' = None,
settings: 'wandb.Settings | None' = None

Persist any changes made to the artifact.

If currently in a run, that run will log this artifact. If not currently in a run, a run of type “auto” is created to track this artifact.

Arguments

• project: A project to use for the artifact in the case that a run is not already in context.
• settings: A settings object to use when initializing an automatic run. Most commonly used in testing harness.

method unlink

self

Unlink this artifact if it is a linked member of an artifact collection.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.
• ValueError: If the artifact is not linked to any collection.

method used_by

self

Get a list of the runs that have used this artifact and its linked artifacts.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.

method verify

self,
root: 'str | None' = None

Verify that the contents of an artifact match the manifest.

All files in the directory are checksummed and the checksums are then cross-referenced against the artifact’s manifest. References are not verified.

Arguments

• root: The directory to verify. If None artifact will be downloaded to ’./artifacts/self.name/’.

Raises

• ArtifactNotLoggedError: If the artifact is not logged.
• ValueError: If the verification fails.

method wait

self,
timeout: 'int | None' = None

If needed, wait for this artifact to finish logging.

Arguments

• timeout: The time, in seconds, to wait.