"""Artifact class.""" from __future__ import annotations import atexit import concurrent.futures import contextlib import json import logging import multiprocessing.dummy import os import re import shutil import stat import tempfile import time from copy import copy from datetime import datetime, timedelta from functools import partial from pathlib import PurePosixPath from typing import IO, TYPE_CHECKING, Any, Dict, Iterator, Literal, Sequence, Type, cast from urllib.parse import urlparse import requests import wandb from wandb import data_types, env, util from wandb.apis.normalize import normalize_exceptions from wandb.apis.public import ArtifactCollection, ArtifactFiles, RetryingClient, Run from wandb.data_types import WBValue from wandb.errors.term import termerror, termlog, termwarn from wandb.sdk.artifacts._validators import ( ensure_logged, ensure_not_finalized, validate_aliases, validate_tags, ) from wandb.sdk.artifacts.artifact_download_logger import ArtifactDownloadLogger from wandb.sdk.artifacts.artifact_instance_cache import artifact_instance_cache from wandb.sdk.artifacts.artifact_manifest import ArtifactManifest from wandb.sdk.artifacts.artifact_manifest_entry import ArtifactManifestEntry from wandb.sdk.artifacts.artifact_manifests.artifact_manifest_v1 import ( ArtifactManifestV1, ) from wandb.sdk.artifacts.artifact_state import ArtifactState from wandb.sdk.artifacts.artifact_ttl import ArtifactTTL from wandb.sdk.artifacts.exceptions import ArtifactNotLoggedError, WaitTimeoutError from wandb.sdk.artifacts.staging import get_staging_dir from wandb.sdk.artifacts.storage_handlers.gcs_handler import _GCSIsADirectoryError from wandb.sdk.artifacts.storage_layout import StorageLayout from wandb.sdk.artifacts.storage_policies import WANDB_STORAGE_POLICY from wandb.sdk.artifacts.storage_policy import StoragePolicy from wandb.sdk.data_types._dtypes import Type as WBType from wandb.sdk.data_types._dtypes import TypeRegistry from wandb.sdk.internal.internal_api import Api as InternalApi from wandb.sdk.internal.thread_local_settings import _thread_local_api_settings from wandb.sdk.lib import filesystem, retry, runid, telemetry from wandb.sdk.lib.deprecate import Deprecated, deprecate from wandb.sdk.lib.hashutil import B64MD5, b64_to_hex_id, md5_file_b64 from wandb.sdk.lib.mailbox import Mailbox from wandb.sdk.lib.paths import FilePathStr, LogicalPath, StrPath, URIStr from wandb.sdk.lib.runid import generate_id reset_path = util.vendor_setup() from wandb_gql import gql # noqa: E402 reset_path() logger = logging.getLogger(__name__) if TYPE_CHECKING: from wandb.sdk.interface.message_future import MessageFuture class Artifact: """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 `wandb.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. 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. Returns: An `Artifact` object. """ _TMP_DIR = tempfile.TemporaryDirectory("wandb-artifacts") atexit.register(_TMP_DIR.cleanup) def __init__( self, name: str, type: str, description: str | None = None, metadata: dict[str, Any] | None = None, incremental: bool = False, use_as: str | None = None, ) -> None: if not re.match(r"^[a-zA-Z0-9_\-.]+$", name): raise ValueError( f"Artifact name may only contain alphanumeric characters, dashes, " f"underscores, and dots. Invalid name: {name}" ) if type == "job" or type.startswith("wandb-"): raise ValueError( "Artifact types 'job' and 'wandb-*' are reserved for internal use. " "Please use a different type." ) if incremental: termwarn("Using experimental arg `incremental`") # Internal. self._client: RetryingClient | None = None storage_policy_cls = StoragePolicy.lookup_by_name(WANDB_STORAGE_POLICY) layout = StorageLayout.V1 if env.get_use_v1_artifacts() else StorageLayout.V2 policy_config = {"storageLayout": layout} self._storage_policy = storage_policy_cls.from_config(config=policy_config) self._tmp_dir: tempfile.TemporaryDirectory | None = None self._added_objs: dict[int, tuple[WBValue, ArtifactManifestEntry]] = {} self._added_local_paths: dict[str, ArtifactManifestEntry] = {} self._save_future: MessageFuture | None = None self._download_roots: set[str] = set() # Set by new_draft(), otherwise the latest artifact will be used as the base. self._base_id: str | None = None # Properties. self._id: str | None = None self._client_id: str = runid.generate_id(128) self._sequence_client_id: str = runid.generate_id(128) self._entity: str | None = None self._project: str | None = None self._name: str = name # includes version after saving self._version: str | None = None self._source_entity: str | None = None self._source_project: str | None = None self._source_name: str = name # includes version after saving self._source_version: str | None = None self._type: str = type self._description: str | None = description self._metadata: dict = self._normalize_metadata(metadata) self._ttl_duration_seconds: int | None = None self._ttl_is_inherited: bool = True self._ttl_changed: bool = False self._aliases: list[str] = [] self._saved_aliases: list[str] = [] self._tags: list[str] = [] self._saved_tags: list[str] = [] self._distributed_id: str | None = None self._incremental: bool = incremental self._use_as: str | None = use_as self._state: ArtifactState = ArtifactState.PENDING self._manifest: ArtifactManifest | None = ArtifactManifestV1( self._storage_policy ) self._commit_hash: str | None = None self._file_count: int | None = None self._created_at: str | None = None self._updated_at: str | None = None self._final: bool = False # Cache. artifact_instance_cache[self._client_id] = self def __repr__(self) -> str: return f"" @classmethod def _from_id(cls, artifact_id: str, client: RetryingClient) -> Artifact | None: artifact = artifact_instance_cache.get(artifact_id) if artifact is not None: return artifact query = gql( """ query ArtifactByID($id: ID!) { artifact(id: $id) { ...ArtifactFragment } } """ + _gql_artifact_fragment() ) response = client.execute( query, variable_values={"id": artifact_id}, ) attrs = response.get("artifact") if attrs is None: return None src_collection = attrs["artifactSequence"] src_project = src_collection["project"] entity_name = src_project["entityName"] if src_project else "" project_name = src_project["name"] if src_project else "" name = "{}:v{}".format(src_collection["name"], attrs["versionIndex"]) return cls._from_attrs(entity_name, project_name, name, attrs, client) @classmethod def _from_name( cls, *, entity: str, project: str, name: str, client: RetryingClient, enable_tracking: bool = False, ) -> Artifact: server_supports_enabling_artifact_usage_tracking = ( InternalApi().server_project_type_introspection() ) query_vars = ["$entityName: String!", "$projectName: String!", "$name: String!"] query_args = ["name: $name"] if server_supports_enabling_artifact_usage_tracking: query_vars.append("$enableTracking: Boolean") query_args.append("enableTracking: $enableTracking") vars_str = ", ".join(query_vars) args_str = ", ".join(query_args) query = gql( f""" query ArtifactByName({vars_str}) {{ project(name: $projectName, entityName: $entityName) {{ artifact({args_str}) {{ ...ArtifactFragment }} }} }} {_gql_artifact_fragment()} """ ) query_variable_values: dict[str, Any] = { "entityName": entity, "projectName": project, "name": name, } if server_supports_enabling_artifact_usage_tracking: query_variable_values["enableTracking"] = enable_tracking response = client.execute( query, variable_values=query_variable_values, ) project_attrs = response.get("project") if not project_attrs: raise ValueError(f"project '{project}' not found under entity '{entity}'") attrs = project_attrs.get("artifact") if not attrs: raise ValueError(f"artifact '{name}' not found in '{entity}/{project}'") return cls._from_attrs(entity, project, name, attrs, client) @classmethod def _from_attrs( cls, entity: str, project: str, name: str, attrs: dict[str, Any], client: RetryingClient, ) -> Artifact: # Placeholder is required to skip validation. artifact = cls("placeholder", type="placeholder") artifact._client = client artifact._entity = entity artifact._project = project artifact._name = name artifact._assign_attrs(attrs) artifact.finalize() # Cache. assert artifact.id is not None artifact_instance_cache[artifact.id] = artifact return artifact def _assign_attrs(self, attrs: dict[str, Any]) -> None: """Update this Artifact's attributes using the server response.""" self._id = attrs["id"] src_version = f"v{attrs['versionIndex']}" src_collection = attrs["artifactSequence"] src_project = src_collection["project"] self._source_entity = src_project["entityName"] if src_project else "" self._source_project = src_project["name"] if src_project else "" self._source_name = f"{src_collection['name']}:{src_version}" self._source_version = src_version if self._entity is None: self._entity = self._source_entity if self._project is None: self._project = self._source_project if self._name is None: self._name = self._source_name self._type = attrs["artifactType"]["name"] self._description = attrs["description"] entity = self._entity project = self._project collection, *_ = self._name.split(":") aliases = [ obj["alias"] for obj in attrs["aliases"] if obj["artifactCollection"] and obj["artifactCollection"]["project"] and obj["artifactCollection"]["project"]["entityName"] == entity and obj["artifactCollection"]["project"]["name"] == project and obj["artifactCollection"]["name"] == collection ] version_aliases = [ alias for alias in aliases if util.alias_is_version_index(alias) ] other_aliases = [ alias for alias in aliases if not util.alias_is_version_index(alias) ] if version_aliases: try: [version] = version_aliases except ValueError: raise ValueError( f"Expected at most one version alias, got {len(version_aliases)}: {version_aliases!r}" ) else: version = src_version self._version = version if ":" not in self._name: self._name = f"{self._name}:{version}" self._aliases = other_aliases self._saved_aliases = copy(other_aliases) tags = [obj["name"] for obj in attrs.get("tags", [])] self._tags = tags self._saved_tags = copy(tags) metadata_str = attrs["metadata"] self.metadata = self._normalize_metadata( json.loads(metadata_str) if metadata_str else {} ) self._ttl_duration_seconds = _ttl_duration_seconds_from_gql( attrs.get("ttlDurationSeconds") ) self._ttl_is_inherited = ( True if (attrs.get("ttlIsInherited") is None) else attrs["ttlIsInherited"] ) self._state = ArtifactState(attrs["state"]) try: manifest_url = attrs["currentManifest"]["file"]["directUrl"] except (LookupError, TypeError): self._manifest = None else: self._manifest = self._load_manifest(manifest_url) self._commit_hash = attrs["commitHash"] self._file_count = attrs["fileCount"] self._created_at = attrs["createdAt"] self._updated_at = attrs["updatedAt"] @ensure_logged def new_draft(self) -> Artifact: """Create a new draft artifact with the same content as this committed artifact. The artifact returned can be extended or modified and logged as a new version. Returns: An `Artifact` object. Raises: ArtifactNotLoggedError: If the artifact is not logged. """ # Name, _entity and _project are set to the *source* name/entity/project: # if this artifact is saved it must be saved to the source sequence. artifact = Artifact(self.source_name.split(":")[0], self.type) artifact._entity = self._source_entity artifact._project = self._source_project artifact._source_entity = self._source_entity artifact._source_project = self._source_project # This artifact's parent is the one we are making a draft from. artifact._base_id = self.id # We can reuse the client, and copy over all the attributes that aren't # version-dependent and don't depend on having been logged. artifact._client = self._client artifact._description = self.description artifact._metadata = self.metadata artifact._manifest = ArtifactManifest.from_manifest_json( self.manifest.to_manifest_json() ) return artifact # Properties (Python Class managed attributes). @property def id(self) -> str | None: """The artifact's ID.""" if self.is_draft(): return None assert self._id is not None return self._id @property @ensure_logged def entity(self) -> str: """The name of the entity of the secondary (portfolio) artifact collection.""" assert self._entity is not None return self._entity @property @ensure_logged def project(self) -> str: """The name of the project of the secondary (portfolio) artifact collection.""" assert self._project is not None return self._project @property def name(self) -> str: """The artifact name and version in its secondary (portfolio) collection. A string with the format `{collection}:{alias}`. Before the artifact is saved, contains only the name since the version is not yet known. """ return self._name @property def qualified_name(self) -> str: """The entity/project/name of the secondary (portfolio) collection.""" return f"{self.entity}/{self.project}/{self.name}" @property @ensure_logged def version(self) -> str: """The artifact's version in its secondary (portfolio) collection.""" assert self._version is not None return self._version @property @ensure_logged def collection(self) -> ArtifactCollection: """The collection this artifact was retrieved from. A collection is an ordered group of artifact versions. If this artifact was retrieved from a portfolio / linked collection, that collection will be returned rather than the collection that an artifact version originated from. The collection that an artifact originates from is known as the source sequence. """ base_name = self.name.split(":")[0] return ArtifactCollection( self._client, self.entity, self.project, base_name, self.type ) @property @ensure_logged def source_entity(self) -> str: """The name of the entity of the primary (sequence) artifact collection.""" assert self._source_entity is not None return self._source_entity @property @ensure_logged def source_project(self) -> str: """The name of the project of the primary (sequence) artifact collection.""" assert self._source_project is not None return self._source_project @property def source_name(self) -> str: """The artifact name and version in its primary (sequence) collection. A string with the format `{collection}:{alias}`. Before the artifact is saved, contains only the name since the version is not yet known. """ return self._source_name @property def source_qualified_name(self) -> str: """The entity/project/name of the primary (sequence) collection.""" return f"{self.source_entity}/{self.source_project}/{self.source_name}" @property @ensure_logged def source_version(self) -> str: """The artifact's version in its primary (sequence) collection. A string with the format `v{number}`. """ assert self._source_version is not None return self._source_version @property @ensure_logged def source_collection(self) -> ArtifactCollection: """The artifact's primary (sequence) collection.""" base_name = self.source_name.split(":")[0] return ArtifactCollection( self._client, self.source_entity, self.source_project, base_name, self.type ) @property def type(self) -> str: """The artifact's type. Common types include `dataset` or `model`.""" return self._type @property def description(self) -> str | None: """A description of the artifact.""" return self._description @description.setter def description(self, description: str | None) -> None: """Set the description of the artifact. For model or dataset Artifacts, add documentation for your standardized team model or dataset card. In the W&B UI the description is rendered as markdown. Args: description: Free text that offers a description of the artifact. """ self._description = description @property def metadata(self) -> dict: """User-defined artifact metadata. Structured data associated with the artifact. """ return self._metadata @metadata.setter def metadata(self, metadata: dict) -> None: """User-defined artifact metadata. Metadata set this way will eventually be queryable and plottable in the UI; e.g. the class distribution of a dataset. Note: There is currently a limit of 100 total keys. Args: metadata: Structured data associated with the artifact. """ self._metadata = self._normalize_metadata(metadata) @property def ttl(self) -> timedelta | None: """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. Raises: ArtifactNotLoggedError: Unable to fetch inherited TTL if the artifact has not been logged or saved """ if self._ttl_is_inherited and (self.is_draft() or self._ttl_changed): raise ArtifactNotLoggedError(f"{type(self).__name__}.ttl", self) if self._ttl_duration_seconds is None: return None return timedelta(seconds=self._ttl_duration_seconds) @ttl.setter def ttl(self, ttl: timedelta | ArtifactTTL | None) -> None: """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 has no TTL policy set and it is not scheduled for deletion. 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. Args: ttl: The duration as a positive Python `datetime.timedelta` Type that represents how long the artifact will remain active from its creation. """ if self.type == "wandb-history": raise ValueError("Cannot set artifact TTL for type wandb-history") self._ttl_changed = True if isinstance(ttl, ArtifactTTL): if ttl == ArtifactTTL.INHERIT: self._ttl_is_inherited = True else: raise ValueError(f"Unhandled ArtifactTTL enum {ttl}") else: self._ttl_is_inherited = False if ttl is None: self._ttl_duration_seconds = None else: if ttl.total_seconds() <= 0: raise ValueError( f"Artifact TTL Duration has to be positive. ttl: {ttl.total_seconds()}" ) self._ttl_duration_seconds = int(ttl.total_seconds()) @property @ensure_logged def aliases(self) -> list[str]: """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](https://docs.wandb.ai/guides/artifacts/create-a-new-artifact-version) for more information. """ return self._aliases @aliases.setter @ensure_logged def aliases(self, aliases: list[str]) -> None: """Set the aliases associated with this artifact.""" self._aliases = validate_aliases(aliases) @property @ensure_logged def tags(self) -> list[str]: """List of one or more tags assigned to this artifact version.""" return self._tags @tags.setter @ensure_logged def tags(self, tags: list[str]) -> None: """Set the tags associated with this artifact.""" self._tags = validate_tags(tags) @property def distributed_id(self) -> str | None: return self._distributed_id @distributed_id.setter def distributed_id(self, distributed_id: str | None) -> None: self._distributed_id = distributed_id @property def incremental(self) -> bool: return self._incremental @property def use_as(self) -> str | None: return self._use_as @property def state(self) -> str: """The status of the artifact. One of: "PENDING", "COMMITTED", or "DELETED".""" return self._state.value @property def manifest(self) -> ArtifactManifest: """The artifact's manifest. The manifest lists all of its contents, and can't be changed once the artifact has been logged. """ if self._manifest is None: query = gql( """ query ArtifactManifest( $entityName: String!, $projectName: String!, $name: String! ) { project(entityName: $entityName, name: $projectName) { artifact(name: $name) { currentManifest { file { directUrl } } } } } """ ) assert self._client is not None response = self._client.execute( query, variable_values={ "entityName": self._entity, "projectName": self._project, "name": self._name, }, ) attrs = response["project"]["artifact"] self._manifest = self._load_manifest( attrs["currentManifest"]["file"]["directUrl"] ) return self._manifest @property def digest(self) -> str: """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. """ return self.manifest.digest() @property def size(self) -> int: """The total size of the artifact in bytes. Includes any references tracked by this artifact. """ total_size: int = 0 for entry in self.manifest.entries.values(): if entry.size is not None: total_size += entry.size return total_size @property @ensure_logged def commit_hash(self) -> str: """The hash returned when this artifact was committed.""" assert self._commit_hash is not None return self._commit_hash @property @ensure_logged def file_count(self) -> int: """The number of files (including references).""" assert self._file_count is not None return self._file_count @property @ensure_logged def created_at(self) -> str: """Timestamp when the artifact was created.""" assert self._created_at is not None return self._created_at @property @ensure_logged def updated_at(self) -> str: """The time when the artifact was last updated.""" assert self._created_at is not None return self._updated_at or self._created_at # State management. def finalize(self) -> None: """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._final = True def is_draft(self) -> bool: """Check if artifact is not saved. Returns: Boolean. `False` if artifact is saved. `True` if artifact is not saved. """ return self._state == ArtifactState.PENDING def _is_draft_save_started(self) -> bool: return self._save_future is not None def save( self, project: str | None = None, settings: wandb.Settings | None = 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. Args: 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. """ if self._state != ArtifactState.PENDING: return self._update() if self._incremental: with telemetry.context() as tel: tel.feature.artifact_incremental = True if wandb.run is None: if settings is None: settings = wandb.Settings(silent="true") with wandb.init( # type: ignore entity=self._source_entity, project=project or self._source_project, job_type="auto", settings=settings, ) as run: # redoing this here because in this branch we know we didn't # have the run at the beginning of the method if self._incremental: with telemetry.context(run=run) as tel: tel.feature.artifact_incremental = True run.log_artifact(self) else: wandb.run.log_artifact(self) def _set_save_future( self, save_future: MessageFuture, client: RetryingClient ) -> None: self._save_future = save_future self._client = client def wait(self, timeout: int | None = None) -> Artifact: """If needed, wait for this artifact to finish logging. Args: timeout: The time, in seconds, to wait. Returns: An `Artifact` object. """ if self.is_draft(): if self._save_future is None: raise ArtifactNotLoggedError(type(self).wait.__qualname__, self) result = self._save_future.get(timeout) if not result: raise WaitTimeoutError( "Artifact upload wait timed out, failed to fetch Artifact response" ) response = result.response.log_artifact_response if response.error_message: raise ValueError(response.error_message) self._populate_after_save(response.artifact_id) return self def _populate_after_save(self, artifact_id: str) -> None: query_template = """ query ArtifactByIDShort($id: ID!) { artifact(id: $id) { ...ArtifactFragment } } """ + _gql_artifact_fragment() query = gql(query_template) assert self._client is not None response = self._client.execute( query, variable_values={"id": artifact_id}, ) try: attrs = response["artifact"] except LookupError: raise ValueError(f"Unable to fetch artifact with id: {artifact_id!r}") else: self._assign_attrs(attrs) @normalize_exceptions def _update(self) -> None: """Persists artifact changes to the wandb backend.""" aliases = None introspect_query = gql( """ query ProbeServerAddAliasesInput { AddAliasesInputInfoType: __type(name: "AddAliasesInput") { name inputFields { name } } } """ ) assert self._client is not None response = self._client.execute(introspect_query) if response.get("AddAliasesInputInfoType"): # wandb backend version >= 0.13.0 aliases_to_add = set(self._aliases) - set(self._saved_aliases) aliases_to_delete = set(self._saved_aliases) - set(self._aliases) if aliases_to_add: add_mutation = gql( """ mutation addAliases( $artifactID: ID!, $aliases: [ArtifactCollectionAliasInput!]!, ) { addAliases( input: {artifactID: $artifactID, aliases: $aliases} ) { success } } """ ) assert self._client is not None self._client.execute( add_mutation, variable_values={ "artifactID": self.id, "aliases": [ { "entityName": self._entity, "projectName": self._project, "artifactCollectionName": self._name.split(":")[0], "alias": alias, } for alias in aliases_to_add ], }, ) if aliases_to_delete: delete_mutation = gql( """ mutation deleteAliases( $artifactID: ID!, $aliases: [ArtifactCollectionAliasInput!]!, ) { deleteAliases( input: {artifactID: $artifactID, aliases: $aliases} ) { success } } """ ) assert self._client is not None self._client.execute( delete_mutation, variable_values={ "artifactID": self.id, "aliases": [ { "entityName": self._entity, "projectName": self._project, "artifactCollectionName": self._name.split(":")[0], "alias": alias, } for alias in aliases_to_delete ], }, ) self._saved_aliases = copy(self._aliases) else: # wandb backend version < 0.13.0 aliases = [ { "artifactCollectionName": self._name.split(":")[0], "alias": alias, } for alias in self._aliases ] mutation_template = """ mutation updateArtifact( $artifactID: ID! $description: String $metadata: JSONString _TTL_DURATION_SECONDS_TYPE_ _TAGS_TO_ADD_TYPE_ _TAGS_TO_DELETE_TYPE_ $aliases: [ArtifactAliasInput!] ) { updateArtifact( input: { artifactID: $artifactID, description: $description, metadata: $metadata, _TTL_DURATION_SECONDS_VALUE_ _TAGS_TO_ADD_VALUE_ _TAGS_TO_DELETE_VALUE_ aliases: $aliases } ) { artifact { ...ArtifactFragment } } } """ + _gql_artifact_fragment() fields = InternalApi().server_artifact_introspection() if "ttlIsInherited" in fields: mutation_template = ( mutation_template.replace( "_TTL_DURATION_SECONDS_TYPE_", "$ttlDurationSeconds: Int64", ) .replace( "_TTL_DURATION_SECONDS_VALUE_", "ttlDurationSeconds: $ttlDurationSeconds", ) .replace( "_TTL_DURATION_SECONDS_FIELDS_", "ttlDurationSeconds ttlIsInherited", ) ) else: if self._ttl_changed: termwarn( "Server not compatible with setting Artifact TTLs, please upgrade the server to use Artifact TTL" ) mutation_template = ( mutation_template.replace("_TTL_DURATION_SECONDS_TYPE_", "") .replace("_TTL_DURATION_SECONDS_VALUE_", "") .replace("_TTL_DURATION_SECONDS_FIELDS_", "") ) tags_to_add = validate_tags(set(self._tags) - set(self._saved_tags)) tags_to_delete = validate_tags(set(self._saved_tags) - set(self._tags)) if "tags" in fields: mutation_template = ( mutation_template.replace( "_TAGS_TO_ADD_TYPE_", "$tagsToAdd: [TagInput!]" ) .replace("_TAGS_TO_DELETE_TYPE_", "$tagsToDelete: [TagInput!]") .replace("_TAGS_TO_ADD_VALUE_", "tagsToAdd: $tagsToAdd") .replace("_TAGS_TO_DELETE_VALUE_", "tagsToDelete: $tagsToDelete") ) else: if tags_to_add or tags_to_delete: termwarn( "Server not compatible with Artifact tags. " "To use Artifact tags, please upgrade the server to v0.85 or higher." ) mutation_template = ( mutation_template.replace("_TAGS_TO_ADD_TYPE_", "") .replace("_TAGS_TO_DELETE_TYPE_", "") .replace("_TAGS_TO_ADD_VALUE_", "") .replace("_TAGS_TO_DELETE_VALUE_", "") ) mutation = gql(mutation_template) assert self._client is not None ttl_duration_input = self._ttl_duration_seconds_to_gql() response = self._client.execute( mutation, variable_values={ "artifactID": self.id, "description": self.description, "metadata": util.json_dumps_safer(self.metadata), "ttlDurationSeconds": ttl_duration_input, "aliases": aliases, "tagsToAdd": [{"tagName": tag_name} for tag_name in tags_to_add], "tagsToDelete": [{"tagName": tag_name} for tag_name in tags_to_delete], }, ) attrs = response["updateArtifact"]["artifact"] self._assign_attrs(attrs) self._ttl_changed = False # Reset after updating artifact # Adding, removing, getting entries. def __getitem__(self, name: str) -> WBValue | None: """Get the WBValue object located at the artifact relative `name`. Args: name: The artifact relative name to get. Returns: W&B object that can be logged with `wandb.log()` and visualized in the W&B UI. Raises: ArtifactNotLoggedError: If the artifact isn't logged or the run is offline. """ return self.get(name) def __setitem__(self, name: str, item: WBValue) -> ArtifactManifestEntry: """Add `item` to the artifact at path `name`. Args: name: The path within the artifact to add the object. item: The object to add. Returns: The added manifest entry Raises: ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead. """ return self.add(item, name) @contextlib.contextmanager @ensure_not_finalized def new_file( self, name: str, mode: str = "x", encoding: str | None = None ) -> Iterator[IO]: """Open a new temporary file and add it to the artifact. Args: 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. Returns: A new file object that can be written to. Upon closing, the file will be automatically added to the artifact. Raises: ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead. """ overwrite: bool = "x" not in mode if self._tmp_dir is None: self._tmp_dir = tempfile.TemporaryDirectory() path = os.path.join(self._tmp_dir.name, name.lstrip("/")) filesystem.mkdir_exists_ok(os.path.dirname(path)) try: with util.fsync_open(path, mode, encoding) as f: yield f except FileExistsError: raise ValueError(f"File with name {name!r} already exists at {path!r}") except UnicodeEncodeError as e: termerror( f"Failed to open the provided file ({type(e).__name__}: {e}). Please " f"provide the proper encoding." ) raise e self.add_file( path, name=name, policy="immutable", skip_cache=True, overwrite=overwrite ) @ensure_not_finalized def 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, ) -> ArtifactManifestEntry: """Add a local file to the artifact. Args: 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`, W&B will 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. Returns: The added manifest entry. 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" """ if not os.path.isfile(local_path): raise ValueError(f"Path is not a file: {local_path!r}") name = LogicalPath(name or os.path.basename(local_path)) digest = md5_file_b64(local_path) if is_tmp: file_path, file_name = os.path.split(name) file_name_parts = file_name.split(".") file_name_parts[0] = b64_to_hex_id(digest)[:20] name = os.path.join(file_path, ".".join(file_name_parts)) return self._add_local_file( name, local_path, digest=digest, skip_cache=skip_cache, policy=policy, overwrite=overwrite, ) @ensure_not_finalized def add_dir( self, local_path: str, name: str | None = None, skip_cache: bool | None = False, policy: Literal["mutable", "immutable"] | None = "mutable", ) -> None: """Add a local directory to the artifact. Args: 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: "mutable" | "immutable". 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. 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" """ if not os.path.isdir(local_path): raise ValueError("Path is not a directory: {}".format(local_path)) termlog( "Adding directory to artifact ({})... ".format( os.path.join(".", os.path.normpath(local_path)) ), newline=False, ) start_time = time.time() paths = [] for dirpath, _, filenames in os.walk(local_path, followlinks=True): for fname in filenames: physical_path = os.path.join(dirpath, fname) logical_path = os.path.relpath(physical_path, start=local_path) if name is not None: logical_path = os.path.join(name, logical_path) paths.append((logical_path, physical_path)) def add_manifest_file(log_phy_path: tuple[str, str]) -> None: logical_path, physical_path = log_phy_path self._add_local_file( name=logical_path, path=physical_path, skip_cache=skip_cache, policy=policy, ) num_threads = 8 pool = multiprocessing.dummy.Pool(num_threads) pool.map(add_manifest_file, paths) pool.close() pool.join() termlog("Done. %.1fs" % (time.time() - start_time), prefix=False) @ensure_not_finalized def add_reference( self, uri: ArtifactManifestEntry | str, name: StrPath | None = None, checksum: bool = True, max_objects: int | None = None, ) -> Sequence[ArtifactManifestEntry]: """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](https://docs.wandb.ai/guides/artifacts/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. Args: 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. Returns: The added manifest entries. Raises: ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead. """ if name is not None: name = LogicalPath(name) # This is a bit of a hack, we want to check if the uri is a of the type # ArtifactManifestEntry. If so, then recover the reference URL. if isinstance(uri, ArtifactManifestEntry): uri_str = uri.ref_url() elif isinstance(uri, str): uri_str = uri url = urlparse(str(uri_str)) if not url.scheme: raise ValueError( "References must be URIs. To reference a local file, use file://" ) manifest_entries = self._storage_policy.store_reference( self, URIStr(uri_str), name=name, checksum=checksum, max_objects=max_objects, ) for entry in manifest_entries: self.manifest.add_entry(entry) return manifest_entries @ensure_not_finalized def add( self, obj: WBValue, name: StrPath, overwrite: bool = False ) -> ArtifactManifestEntry: """Add wandb.WBValue `obj` to the artifact. Args: 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). Returns: The added manifest entry Raises: ArtifactFinalizedError: You cannot make changes to the current artifact version because it is finalized. Log a new artifact version instead. """ name = LogicalPath(name) # This is a "hack" to automatically rename tables added to # the wandb /media/tables directory to their sha-based name. # TODO: figure out a more appropriate convention. is_tmp_name = name.startswith("media/tables") # Validate that the object is one of the correct wandb.Media types # TODO: move this to checking subclass of wandb.Media once all are # generally supported allowed_types = ( data_types.Bokeh, data_types.JoinedTable, data_types.PartitionedTable, data_types.Table, data_types.Classes, data_types.ImageMask, data_types.BoundingBoxes2D, data_types.Audio, data_types.Image, data_types.Video, data_types.Html, data_types.Object3D, data_types.Molecule, data_types._SavedModel, ) if not isinstance(obj, allowed_types): raise ValueError( f"Found object of type {obj.__class__}, expected one of: {allowed_types}" ) obj_id = id(obj) if obj_id in self._added_objs: return self._added_objs[obj_id][1] # If the object is coming from another artifact, save it as a reference ref_path = obj._get_artifact_entry_ref_url() if ref_path is not None: return self.add_reference(ref_path, type(obj).with_suffix(name))[0] val = obj.to_json(self) name = obj.with_suffix(name) entry = self.manifest.get_entry_by_path(name) if (not overwrite) and (entry is not None): return entry if is_tmp_name: file_path = os.path.join(self._TMP_DIR.name, str(id(self)), name) folder_path, _ = os.path.split(file_path) os.makedirs(folder_path, exist_ok=True) with open(file_path, "w", encoding="utf-8") as tmp_f: json.dump(val, tmp_f, sort_keys=True) else: filemode = "w" if overwrite else "x" with self.new_file(name, mode=filemode, encoding="utf-8") as f: json.dump(val, f, sort_keys=True) file_path = f.name # Note, we add the file from our temp directory. # It will be added again later on finalize, but succeed since # the checksum should match entry = self.add_file(file_path, name, is_tmp_name) # We store a reference to the obj so that its id doesn't get reused. self._added_objs[obj_id] = (obj, entry) if obj._artifact_target is None: obj._set_artifact_target(self, entry.path) if is_tmp_name: with contextlib.suppress(FileNotFoundError): os.remove(file_path) return entry def _add_local_file( self, name: StrPath, path: StrPath, digest: B64MD5 | None = None, skip_cache: bool | None = False, policy: Literal["mutable", "immutable"] | None = "mutable", overwrite: bool = False, ) -> ArtifactManifestEntry: policy = policy or "mutable" if policy not in ["mutable", "immutable"]: raise ValueError( f"Invalid policy {policy!r}. Policy may only be `mutable` or `immutable`." ) upload_path = path if policy == "mutable": with tempfile.NamedTemporaryFile(dir=get_staging_dir(), delete=False) as f: staging_path = f.name shutil.copyfile(path, staging_path) # Set as read-only to prevent changes to the file during upload process os.chmod(staging_path, stat.S_IRUSR) upload_path = staging_path entry = ArtifactManifestEntry( path=name, digest=digest or md5_file_b64(upload_path), size=os.path.getsize(upload_path), local_path=upload_path, skip_cache=skip_cache, ) self.manifest.add_entry(entry, overwrite=overwrite) self._added_local_paths[os.fspath(path)] = entry return entry @ensure_not_finalized def remove(self, item: StrPath | ArtifactManifestEntry) -> None: """Remove an item from the artifact. Args: 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. """ if isinstance(item, ArtifactManifestEntry): self.manifest.remove_entry(item) return path = str(PurePosixPath(item)) entry = self.manifest.get_entry_by_path(path) if entry: self.manifest.remove_entry(entry) return entries = self.manifest.get_entries_in_directory(path) if not entries: raise FileNotFoundError(f"No such file or directory: {path}") for entry in entries: self.manifest.remove_entry(entry) def get_path(self, name: StrPath) -> ArtifactManifestEntry: """Deprecated. Use `get_entry(name)`.""" deprecate( field_name=Deprecated.artifact__get_path, warning_message="Artifact.get_path(name) is deprecated, use Artifact.get_entry(name) instead.", ) return self.get_entry(name) @ensure_logged def get_entry(self, name: StrPath) -> ArtifactManifestEntry: """Get the entry with the given name. Args: name: The artifact relative name to get Returns: A `W&B` object. 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. """ name = LogicalPath(name) entry = self.manifest.entries.get(name) or self._get_obj_entry(name)[0] if entry is None: raise KeyError("Path not contained in artifact: {}".format(name)) entry._parent_artifact = self return entry @ensure_logged def get(self, name: str) -> WBValue | None: """Get the WBValue object located at the artifact relative `name`. Args: name: The artifact relative name to retrieve. Returns: W&B object that can be logged with `wandb.log()` and visualized in the W&B UI. Raises: ArtifactNotLoggedError: if the artifact isn't logged or the run is offline """ entry, wb_class = self._get_obj_entry(name) if entry is None or wb_class is None: return None # If the entry is a reference from another artifact, then get it directly from # that artifact. referenced_id = entry._referenced_artifact_id() if referenced_id: assert self._client is not None artifact = self._from_id(referenced_id, client=self._client) assert artifact is not None return artifact.get(util.uri_from_path(entry.ref)) # Special case for wandb.Table. This is intended to be a short term # optimization. Since tables are likely to download many other assets in # artifact(s), we eagerly download the artifact using the parallelized # `artifact.download`. In the future, we should refactor the deserialization # pattern such that this special case is not needed. if wb_class == wandb.Table: self.download() # Get the ArtifactManifestEntry item = self.get_entry(entry.path) item_path = item.download() # Load the object from the JSON blob result = None json_obj = {} with open(item_path) as file: json_obj = json.load(file) result = wb_class.from_json(json_obj, self) result._set_artifact_source(self, name) return result def get_added_local_path_name(self, local_path: str) -> str | None: """Get the artifact relative name of a file added by a local filesystem path. Args: local_path: The local path to resolve into an artifact relative name. Returns: The artifact relative name. """ entry = self._added_local_paths.get(local_path, None) if entry is None: return None return entry.path def _get_obj_entry( self, name: str ) -> tuple[ArtifactManifestEntry, Type[WBValue]] | tuple[None, None]: # noqa: UP006 # `type` shadows `Artifact.type` """Return an object entry by name, handling any type suffixes. When objects are added with `.add(obj, name)`, the name is typically changed to include the suffix of the object type when serializing to JSON. So we need to be able to resolve a name, without tasking the user with appending .THING.json. This method returns an entry if it exists by a suffixed name. Args: name: name used when adding """ for wb_class in WBValue.type_mapping().values(): wandb_file_name = wb_class.with_suffix(name) entry = self.manifest.entries.get(wandb_file_name) if entry is not None: return entry, wb_class return None, None # Downloading. @ensure_logged def download( self, root: StrPath | None = None, allow_missing_references: bool = False, skip_cache: bool | None = None, path_prefix: StrPath | None = None, ) -> FilePathStr: """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. Args: 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). Returns: The path to the downloaded contents. Raises: ArtifactNotLoggedError: If the artifact is not logged. RuntimeError: If the artifact is attempted to be downloaded in offline mode. """ root = FilePathStr(str(root or self._default_root())) self._add_download_root(root) # TODO: we need a better way to check for offline mode across the app, as this is an anti-pattern if env.is_offline() or util._is_offline(): raise RuntimeError("Cannot download artifacts in offline mode.") # TODO: download artifacts using core when implemented # if is_require_core(): # return self._download_using_core( # root=root, # allow_missing_references=allow_missing_references, # skip_cache=bool(skip_cache), # path_prefix=path_prefix, # ) return self._download( root=root, allow_missing_references=allow_missing_references, skip_cache=skip_cache, path_prefix=path_prefix, ) def _download_using_core( self, root: str, allow_missing_references: bool = False, skip_cache: bool = False, path_prefix: StrPath | None = None, ) -> FilePathStr: import pathlib from wandb.sdk.backend.backend import Backend if wandb.run is None: # ensure wandb-core is up and running from wandb.sdk import wandb_setup wl = wandb_setup.setup() assert wl is not None stream_id = generate_id() settings = wl.settings.to_proto() # TODO: remove this tmp_dir = pathlib.Path(tempfile.mkdtemp()) settings.sync_dir.value = str(tmp_dir) settings.sync_file.value = str(tmp_dir / f"{stream_id}.wandb") settings.files_dir.value = str(tmp_dir / "files") settings.run_id.value = stream_id service = wl.service assert service service.inform_init(settings=settings, run_id=stream_id) mailbox = Mailbox() backend = Backend( settings=wl.settings, service=service, mailbox=mailbox, ) backend.ensure_launched() assert backend.interface backend.interface._stream_id = stream_id # type: ignore mailbox.enable_keepalive() else: assert wandb.run._backend backend = wandb.run._backend assert backend.interface handle = backend.interface.deliver_download_artifact( self.id, # type: ignore root, allow_missing_references, skip_cache, path_prefix, # type: ignore ) # TODO: Start the download process in the user process too, to handle reference downloads self._download( root=root, allow_missing_references=allow_missing_references, skip_cache=skip_cache, path_prefix=path_prefix, ) result = handle.wait(timeout=-1) if result is None: handle.abandon() assert result is not None response = result.response.download_artifact_response if response.error_message: raise ValueError(f"Error downloading artifact: {response.error_message}") return FilePathStr(root) def _download( self, root: str, allow_missing_references: bool = False, skip_cache: bool | None = None, path_prefix: StrPath | None = None, ) -> FilePathStr: nfiles = len(self.manifest.entries) size = sum(e.size or 0 for e in self.manifest.entries.values()) log = False if nfiles > 5000 or size > 50 * 1024 * 1024: log = True termlog( "Downloading large artifact {}, {:.2f}MB. {} files... ".format( self.name, size / (1024 * 1024), nfiles ), ) start_time = datetime.now() download_logger = ArtifactDownloadLogger(nfiles=nfiles) def _download_entry( entry: ArtifactManifestEntry, api_key: str | None, cookies: dict | None, headers: dict | None, ) -> None: _thread_local_api_settings.api_key = api_key _thread_local_api_settings.cookies = cookies _thread_local_api_settings.headers = headers try: entry.download(root, skip_cache=skip_cache) except FileNotFoundError as e: if allow_missing_references: wandb.termwarn(str(e)) return raise except _GCSIsADirectoryError as e: logger.debug(str(e)) return download_logger.notify_downloaded() download_entry = partial( _download_entry, api_key=_thread_local_api_settings.api_key, cookies=_thread_local_api_settings.cookies, headers=_thread_local_api_settings.headers, ) with concurrent.futures.ThreadPoolExecutor(64) as executor: active_futures = set() has_next_page = True cursor = None while has_next_page: fetch_url_batch_size = env.get_artifact_fetch_file_url_batch_size() attrs = self._fetch_file_urls(cursor, fetch_url_batch_size) has_next_page = attrs["pageInfo"]["hasNextPage"] cursor = attrs["pageInfo"]["endCursor"] for edge in attrs["edges"]: entry = self.get_entry(edge["node"]["name"]) # TODO: uncomment once artifact downloads are supported in core # if require_core and entry.ref is None: # # Handled by core # continue entry._download_url = edge["node"]["directUrl"] if (not path_prefix) or entry.path.startswith(str(path_prefix)): active_futures.add(executor.submit(download_entry, entry)) # Wait for download threads to catch up. max_backlog = fetch_url_batch_size if len(active_futures) > max_backlog: for future in concurrent.futures.as_completed(active_futures): future.result() # check for errors active_futures.remove(future) if len(active_futures) <= max_backlog: break # Check for errors. for future in concurrent.futures.as_completed(active_futures): future.result() if log: now = datetime.now() delta = abs((now - start_time).total_seconds()) hours = int(delta // 3600) minutes = int((delta - hours * 3600) // 60) seconds = delta - hours * 3600 - minutes * 60 termlog( f"Done. {hours}:{minutes}:{seconds:.1f}", prefix=False, ) return FilePathStr(root) @retry.retriable( retry_timedelta=timedelta(minutes=3), retryable_exceptions=(requests.RequestException), ) def _fetch_file_urls(self, cursor: str | None, per_page: int | None = 5000) -> Any: query = gql( """ query ArtifactFileURLs($id: ID!, $cursor: String, $perPage: Int) { artifact(id: $id) { files(after: $cursor, first: $perPage) { pageInfo { hasNextPage endCursor } edges { node { name directUrl } } } } } """ ) assert self._client is not None response = self._client.execute( query, variable_values={"id": self.id, "cursor": cursor, "perPage": per_page}, timeout=60, ) return response["artifact"]["files"] @ensure_logged def checkout(self, root: str | None = None) -> str: """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. Args: root: The directory to replace with this artifact's files. Returns: The path of the checked out contents. Raises: ArtifactNotLoggedError: If the artifact is not logged. """ root = root or self._default_root(include_version=False) for dirpath, _, files in os.walk(root): for file in files: full_path = os.path.join(dirpath, file) artifact_path = os.path.relpath(full_path, start=root) try: self.get_entry(artifact_path) except KeyError: # File is not part of the artifact, remove it. os.remove(full_path) return self.download(root=root) @ensure_logged def verify(self, root: str | None = 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. Args: 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. """ root = root or self._default_root() for dirpath, _, files in os.walk(root): for file in files: full_path = os.path.join(dirpath, file) artifact_path = os.path.relpath(full_path, start=root) try: self.get_entry(artifact_path) except KeyError: raise ValueError( "Found file {} which is not a member of artifact {}".format( full_path, self.name ) ) ref_count = 0 for entry in self.manifest.entries.values(): if entry.ref is None: if md5_file_b64(os.path.join(root, entry.path)) != entry.digest: raise ValueError("Digest mismatch for file: {}".format(entry.path)) else: ref_count += 1 if ref_count > 0: print("Warning: skipped verification of {} refs".format(ref_count)) @ensure_logged def file(self, root: str | None = None) -> StrPath: """Download a single file artifact to the directory you specify with `root`. Args: root: The root directory to store the file. Defaults to './artifacts/self.name/'. Returns: The full path of the downloaded file. Raises: ArtifactNotLoggedError: If the artifact is not logged. ValueError: If the artifact contains more than one file. """ if root is None: root = os.path.join(".", "artifacts", self.name) if len(self.manifest.entries) > 1: raise ValueError( "This artifact contains more than one file, call `.download()` to get " 'all files or call .get_entry("filename").download()' ) return self.get_entry(list(self.manifest.entries)[0]).download(root) @ensure_logged def files( self, names: list[str] | None = None, per_page: int = 50 ) -> ArtifactFiles: """Iterate over all files stored in this artifact. Args: 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. Returns: An iterator containing `File` objects. Raises: ArtifactNotLoggedError: If the artifact is not logged. """ return ArtifactFiles(self._client, self, names, per_page) def _default_root(self, include_version: bool = True) -> FilePathStr: name = self.source_name if include_version else self.source_name.split(":")[0] root = os.path.join(env.get_artifact_dir(), name) # In case we're on a system where the artifact dir has a name corresponding to # an unexpected filesystem, we'll check for alternate roots. If one exists we'll # use that, otherwise we'll fall back to the system-preferred path. path = filesystem.check_exists(root) or filesystem.system_preferred_path(root) return FilePathStr(str(path)) def _add_download_root(self, dir_path: str) -> None: self._download_roots.add(os.path.abspath(dir_path)) def _local_path_to_name(self, file_path: str) -> str | None: """Convert a local file path to a path entry in the artifact.""" abs_file_path = os.path.abspath(file_path) abs_file_parts = abs_file_path.split(os.sep) for i in range(len(abs_file_parts) + 1): if os.path.join(os.sep, *abs_file_parts[:i]) in self._download_roots: return os.path.join(*abs_file_parts[i:]) return None # Others. @ensure_logged def delete(self, delete_aliases: bool = False) -> None: """Delete an artifact and its files. If called on a linked artifact (i.e. a member of a portfolio collection): only the link is deleted, and the source artifact is unaffected. Args: delete_aliases: If set to `True`, deletes all aliases associated with the artifact. Otherwise, this raises an exception if the artifact has existing aliases. This parameter is ignored if the artifact is linked (i.e. a member of a portfolio collection). Raises: ArtifactNotLoggedError: If the artifact is not logged. """ if self.collection.is_sequence(): self._delete(delete_aliases) else: self._unlink() @normalize_exceptions def _delete(self, delete_aliases: bool = False) -> None: mutation = gql( """ mutation DeleteArtifact($artifactID: ID!, $deleteAliases: Boolean) { deleteArtifact(input: { artifactID: $artifactID deleteAliases: $deleteAliases }) { artifact { id } } } """ ) assert self._client is not None self._client.execute( mutation, variable_values={ "artifactID": self.id, "deleteAliases": delete_aliases, }, ) @normalize_exceptions def link(self, target_path: str, aliases: list[str] | None = None) -> None: """Link this artifact to a portfolio (a promoted collection of artifacts). Args: target_path: The path to the portfolio inside a project. The target path must adhere to one of the following schemas `{portfolio}`, `{project}/{portfolio}` or `{entity}/{project}/{portfolio}`. To link the artifact to the Model Registry, rather than to a generic portfolio inside a project, set `target_path` to the following schema `{"model-registry"}/{Registered Model Name}` or `{entity}/{"model-registry"}/{Registered Model Name}`. aliases: A list of strings that uniquely identifies the artifact inside the specified portfolio. Raises: ArtifactNotLoggedError: If the artifact is not logged. """ if wandb.run is None: with wandb.init( # type: ignore entity=self._source_entity, project=self._source_project, job_type="auto", settings=wandb.Settings(silent="true"), ) as run: run.link_artifact(self, target_path, aliases) else: wandb.run.link_artifact(self, target_path, aliases) @ensure_logged def unlink(self) -> None: """Unlink this artifact if it is currently a member of a portfolio (a promoted collection of artifacts). Raises: ArtifactNotLoggedError: If the artifact is not logged. ValueError: If the artifact is not linked, i.e. it is not a member of a portfolio collection. """ # Fail early if this isn't a linked artifact to begin with if self.collection.is_sequence(): raise ValueError( f"Artifact {self.qualified_name!r} is not a linked artifact and cannot be unlinked. " f"To delete it, use {self.delete.__qualname__!r} instead." ) self._unlink() @normalize_exceptions def _unlink(self) -> None: mutation = gql( """ mutation UnlinkArtifact($artifactID: ID!, $artifactPortfolioID: ID!) { unlinkArtifact( input: { artifactID: $artifactID, artifactPortfolioID: $artifactPortfolioID } ) { artifactID success clientMutationId } } """ ) assert self._client is not None self._client.execute( mutation, variable_values={ "artifactID": self.id, "artifactPortfolioID": self.collection.id, }, ) @ensure_logged def used_by(self) -> list[Run]: """Get a list of the runs that have used this artifact. Returns: A list of `Run` objects. Raises: ArtifactNotLoggedError: If the artifact is not logged. """ query = gql( """ query ArtifactUsedBy( $id: ID!, ) { artifact(id: $id) { usedBy { edges { node { name project { name entityName } } } } } } """ ) assert self._client is not None response = self._client.execute( query, variable_values={"id": self.id}, ) return [ Run( self._client, edge["node"]["project"]["entityName"], edge["node"]["project"]["name"], edge["node"]["name"], ) for edge in response.get("artifact", {}).get("usedBy", {}).get("edges", []) ] @ensure_logged def logged_by(self) -> Run | None: """Get the W&B run that originally logged the artifact. Returns: The name of the W&B run that originally logged the artifact. Raises: ArtifactNotLoggedError: If the artifact is not logged. """ query = gql( """ query ArtifactCreatedBy( $id: ID! ) { artifact(id: $id) { createdBy { ... on Run { name project { name entityName } } } } } """ ) assert self._client is not None response = self._client.execute( query, variable_values={"id": self.id}, ) creator = response.get("artifact", {}).get("createdBy", {}) if creator.get("name") is None: return None return Run( self._client, creator["project"]["entityName"], creator["project"]["name"], creator["name"], ) @ensure_logged def json_encode(self) -> dict[str, Any]: """Returns the artifact encoded to the JSON format. Returns: A `dict` with `string` keys representing attributes of the artifact. """ return util.artifact_to_json(self) @staticmethod def _expected_type( entity_name: str, project_name: str, name: str, client: RetryingClient ) -> str | None: """Returns the expected type for a given artifact name and project.""" query = gql( """ query ArtifactType( $entityName: String, $projectName: String, $name: String! ) { project(name: $projectName, entityName: $entityName) { artifact(name: $name) { artifactType { name } } } } """ ) if ":" not in name: name += ":latest" response = client.execute( query, variable_values={ "entityName": entity_name, "projectName": project_name, "name": name, }, ) return ( ((response.get("project") or {}).get("artifact") or {}).get("artifactType") or {} ).get("name") @staticmethod def _normalize_metadata(metadata: dict[str, Any] | None) -> dict[str, Any]: if metadata is None: return {} if not isinstance(metadata, dict): raise TypeError(f"metadata must be dict, not {type(metadata)}") return cast( Dict[str, Any], json.loads(json.dumps(util.json_friendly_val(metadata))) ) def _load_manifest(self, url: str) -> ArtifactManifest: with requests.get(url) as response: response.raise_for_status() return ArtifactManifest.from_manifest_json(response.json()) def _ttl_duration_seconds_to_gql(self) -> int | None: # Set artifact ttl value to ttl_duration_seconds if the user set a value # otherwise use ttl_status to indicate the backend INHERIT(-1) or DISABLED(-2) when the TTL is None # When ttl_change = None its a no op since nothing changed INHERIT = -1 # noqa: N806 DISABLED = -2 # noqa: N806 if not self._ttl_changed: return None if self._ttl_is_inherited: return INHERIT return self._ttl_duration_seconds or DISABLED def _ttl_duration_seconds_from_gql(gql_ttl_duration_seconds: int | None) -> int | None: # If gql_ttl_duration_seconds is not positive, its indicating that TTL is DISABLED(-2) # gql_ttl_duration_seconds only returns None if the server is not compatible with setting Artifact TTLs if gql_ttl_duration_seconds and gql_ttl_duration_seconds > 0: return gql_ttl_duration_seconds return None def _gql_artifact_fragment() -> str: """Return a GraphQL query fragment with all parseable Artifact attributes.""" allowed_fields = set(InternalApi().server_artifact_introspection()) supports_ttl = "ttlIsInherited" in allowed_fields supports_tags = "tags" in allowed_fields ttl_duration_seconds = "ttlDurationSeconds" if supports_ttl else "" ttl_is_inherited = "ttlIsInherited" if supports_ttl else "" tags = "tags {name}" if supports_tags else "" return f""" fragment ArtifactFragment on Artifact {{ id artifactSequence {{ project {{ entityName name }} name }} versionIndex artifactType {{ name }} description metadata {ttl_duration_seconds} {ttl_is_inherited} aliases {{ artifactCollection {{ project {{ entityName name }} name }} alias }} {tags} state currentManifest {{ file {{ directUrl }} }} commitHash fileCount createdAt updatedAt }} """ class _ArtifactVersionType(WBType): name = "artifactVersion" types = [Artifact] TypeRegistry.add(_ArtifactVersionType)