Artifact methods - Weights & Biases Documentation

Class wandb.Artifact

method Artifact.add()

Add wandb.WBValue obj to the artifact.

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

Arguments

WBValue

The object to add. Currently support one of Bokeh, JoinedTable, PartitionedTable, Table, Classes, ImageMask, BoundingBoxes2D, Audio, Image, Video, Html, Object3D

StrPath

The path within the artifact to add the object.

bool

If True, overwrite existing objects with the same file path if applicable.

Returns

The added manifest entry

Raises

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

method Artifact.add_dir()

Add a local directory to the artifact.

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

Arguments

str

The path of the local directory.

str | None

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.

bool | None

If set to True, W&B will not copy/move files to the cache while uploading

Literal['mutable', 'immutable'] | None

By default, “mutable”.

mutable: Create a temporary copy of the file to prevent corruption during upload.
immutable: Disable protection, rely on the user not to delete or change the file.

bool

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

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

Policy must be “mutable” or “immutable”

method Artifact.add_file()

Add a local file to the artifact.

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

Arguments

str

The path to the file being added.

str | None

The path within the artifact to use for the file being added. Defaults to the basename of the file.

bool | None

If true, then the file is renamed deterministically to avoid collisions.

bool | None

If True, do not copy files to the cache after uploading.

Literal['mutable', 'immutable'] | None

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.

bool

If True, overwrite the file if it already exists.

Returns

The added manifest entry.

Raises

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

Policy must be “mutable” or “immutable”

method Artifact.add_reference()

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.

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

Arguments

ArtifactManifestEntry | str

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.

StrPath | None

The path within the artifact to place the contents of this reference.

bool

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.

int | None

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.

Returns

The added manifest entries.

Raises

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

method Artifact.checkout()

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.

self,
root: 'str | None' = None

Arguments

str | None

The directory to replace with this artifact’s files.

Returns

The path of the checked out contents.

Raises

If the artifact is not logged.

method Artifact.delete()

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.

self,
delete_aliases: 'bool' = False

Arguments

bool

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

If the artifact is not logged.

method Artifact.download()

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.

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

Arguments

StrPath | None

The directory W&B stores the artifact’s files.

bool

If set to True, any invalid reference paths will be ignored while downloading referenced files.

bool | None

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.

StrPath | None

If specified, only files with a path that starts with the given prefix will be downloaded. Uses unix format (forward slashes).

bool | None

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.

Returns

The path to the downloaded contents.

Raises

If the artifact is not logged.

method Artifact.file()

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

self,
root: 'str | None' = None

Arguments

str | None

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

Returns

The full path of the downloaded file.

Raises

If the artifact is not logged.

If the artifact contains more than one file.

method Artifact.files()

Iterate over all files stored in this artifact.

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

Arguments

list[str] | None

The filename paths relative to the root of the artifact you wish to list.

int

The number of files to return per request.

str | None

Pagination cursor for resuming a past query, captured from a previous paginator’s .cursor attribute.

Returns

An iterator containing File objects.

Raises

If the artifact is not logged.

method Artifact.finalize()

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.

self

method Artifact.get()

Get the WBValue object located at the artifact relative name.

self,
name: 'str'

Arguments

str

The artifact relative name to retrieve.

Returns

W&B object that can be logged with run.log() and visualized in the W&B UI.

Raises

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

method Artifact.get_added_local_path_name()

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

self,
local_path: 'str'

Arguments

str

The local path to resolve into an artifact relative name.

Returns

The artifact relative name.

method Artifact.get_entry()

Get the entry with the given name.

self,
name: 'StrPath'

Arguments

StrPath

The artifact relative name to get

Returns

A W&B object.

Raises

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

if the artifact doesn’t contain an entry with the given name.

method Artifact.get_path()

Deprecated. Use get_entry(name).

self,
name: 'StrPath'

Arguments

StrPath

method Artifact.is_draft()

Check if artifact is not saved.

self

Returns

Boolean. False if artifact is saved. True if artifact is not saved.

method Artifact.json_encode()

Returns the artifact encoded to the JSON format.

self

Returns

A dict with string keys representing attributes of the artifact.

method Artifact.link()

Link this artifact to a collection.

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

Arguments

str

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

Iterable[str] | None

Add one or more aliases to the linked artifact. The “latest” alias is automatically applied to the most recent artifact you link.

Returns

The linked artifact.

Raises

If the artifact is not logged.

method Artifact.logged_by()

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

self

Returns

The name of the W&B run that originally logged the artifact.

Raises

If the artifact is not logged.

method Artifact.new_draft()

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.

self

Returns

An Artifact object.

Raises

If the artifact is not logged.

method Artifact.new_file()

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

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

Arguments

str

The name of the new file to add to the artifact.

str

The file access mode to use to open the new file.

str | None

The encoding used to open the new file.

Returns

A new file object that can be written to. Upon closing, the file is automatically added to the artifact.

Raises

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

method Artifact.remove()

Remove an item from the artifact.

self,
item: 'StrPath | ArtifactManifestEntry'

Arguments

StrPath | ArtifactManifestEntry

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

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

If the item isn’t found in the artifact.

method Artifact.save()

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.

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

Arguments

str | None

A project to use for the artifact in the case that a run is not already in context.

wandb.Settings | None

A settings object to use when initializing an automatic run. Most commonly used in testing harness.

method Artifact.unlink()

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

self

Raises

If the artifact is not logged.

If the artifact is not linked to any collection.

method Artifact.used_by()

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

self

Returns

A list of Run objects.

Raises

If the artifact is not logged.

method Artifact.verify()

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.

self,
root: 'str | None' = None

Arguments

str | None

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

Raises

If the artifact is not logged.

If the verification fails.

method Artifact.wait()

If needed, wait for this artifact to finish logging.

self,
timeout: 'int | None' = None

Arguments

int | None

The time, in seconds, to wait.

Returns

An Artifact object.

​Class wandb.Artifact

​method Artifact.add()

Arguments

Returns

Raises

​method Artifact.add_dir()

Arguments

Raises

​method Artifact.add_file()

Arguments

Returns

Raises

​method Artifact.add_reference()

Arguments

Returns

Raises

​method Artifact.checkout()

Arguments

Returns

Raises

​method Artifact.delete()

Arguments

Raises

​method Artifact.download()

Arguments

Returns

Raises

​method Artifact.file()

Arguments

Returns

Raises

​method Artifact.files()

Arguments

Returns

Raises

​method Artifact.finalize()

​method Artifact.get()

Arguments

Returns

Raises

​method Artifact.get_added_local_path_name()

Arguments

Returns

​method Artifact.get_entry()

Arguments

Returns

Raises

​method Artifact.get_path()

Arguments

​method Artifact.is_draft()

Returns

​method Artifact.json_encode()

Returns

​method Artifact.link()

Arguments

Returns

Raises

​method Artifact.logged_by()

Returns

Raises

​method Artifact.new_draft()

Returns

Raises

​method Artifact.new_file()

Arguments

Returns

Raises

​method Artifact.remove()

Arguments

Raises

​method Artifact.save()

Arguments

​method Artifact.unlink()

Raises

​method Artifact.used_by()

Returns

Raises

​method Artifact.verify()

Arguments

Raises

Class wandb.Artifact

method Artifact.add()

method Artifact.add_dir()

method Artifact.add_file()

method Artifact.add_reference()

method Artifact.checkout()

method Artifact.delete()

method Artifact.download()

method Artifact.file()

method Artifact.files()

method Artifact.finalize()

method Artifact.get()

method Artifact.get_added_local_path_name()

method Artifact.get_entry()

method Artifact.get_path()

method Artifact.is_draft()

method Artifact.json_encode()

method Artifact.link()

method Artifact.logged_by()

method Artifact.new_draft()

method Artifact.new_file()

method Artifact.remove()

method Artifact.save()

method Artifact.unlink()

method Artifact.used_by()

method Artifact.verify()

method Artifact.wait()