File size: 9,654 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
"""Artifact saver."""
from __future__ import annotations
import concurrent.futures
import json
import os
import tempfile
from typing import TYPE_CHECKING, Awaitable, Sequence
import wandb
import wandb.filesync.step_prepare
from wandb import util
from wandb.sdk.artifacts.artifact_manifest import ArtifactManifest
from wandb.sdk.lib.hashutil import B64MD5, b64_to_hex_id, md5_file_b64
from wandb.sdk.lib.paths import URIStr
if TYPE_CHECKING:
from typing import Protocol
from wandb.sdk.artifacts.artifact_manifest_entry import ArtifactManifestEntry
from wandb.sdk.internal.file_pusher import FilePusher
from wandb.sdk.internal.internal_api import Api as InternalApi
from wandb.sdk.internal.progress import ProgressFn
class SaveFn(Protocol):
def __call__(
self, entry: ArtifactManifestEntry, progress_callback: ProgressFn
) -> bool:
pass
class SaveFnAsync(Protocol):
def __call__(
self, entry: ArtifactManifestEntry, progress_callback: ProgressFn
) -> Awaitable[bool]:
pass
class ArtifactSaver:
_server_artifact: dict | None # TODO better define this dict
def __init__(
self,
api: InternalApi,
digest: str,
manifest_json: dict,
file_pusher: FilePusher,
is_user_created: bool = False,
) -> None:
self._api = api
self._file_pusher = file_pusher
self._digest = digest
self._manifest = ArtifactManifest.from_manifest_json(
manifest_json,
api=self._api,
)
self._is_user_created = is_user_created
self._server_artifact = None
def save(
self,
entity: str,
project: str,
type: str,
name: str,
client_id: str,
sequence_client_id: str,
distributed_id: str | None = None,
finalize: bool = True,
metadata: dict | None = None,
ttl_duration_seconds: int | None = None,
description: str | None = None,
aliases: Sequence[str] | None = None,
tags: Sequence[str] | None = None,
use_after_commit: bool = False,
incremental: bool = False,
history_step: int | None = None,
base_id: str | None = None,
) -> dict | None:
return self._save_internal(
entity,
project,
type,
name,
client_id,
sequence_client_id,
distributed_id,
finalize,
metadata,
ttl_duration_seconds,
description,
aliases,
tags,
use_after_commit,
incremental,
history_step,
base_id,
)
def _save_internal(
self,
entity: str,
project: str,
type: str,
name: str,
client_id: str,
sequence_client_id: str,
distributed_id: str | None = None,
finalize: bool = True,
metadata: dict | None = None,
ttl_duration_seconds: int | None = None,
description: str | None = None,
aliases: Sequence[str] | None = None,
tags: Sequence[str] | None = None,
use_after_commit: bool = False,
incremental: bool = False,
history_step: int | None = None,
base_id: str | None = None,
) -> dict | None:
alias_specs = []
for alias in aliases or []:
alias_specs.append({"artifactCollectionName": name, "alias": alias})
tag_specs = [{"tagName": tag} for tag in tags or []]
"""Returns the server artifact."""
self._server_artifact, latest = self._api.create_artifact(
type,
name,
self._digest,
metadata=metadata,
ttl_duration_seconds=ttl_duration_seconds,
aliases=alias_specs,
tags=tag_specs,
description=description,
is_user_created=self._is_user_created,
distributed_id=distributed_id,
client_id=client_id,
sequence_client_id=sequence_client_id,
history_step=history_step,
)
assert self._server_artifact is not None # mypy optionality unwrapper
artifact_id = self._server_artifact["id"]
if base_id is None and latest:
base_id = latest["id"]
if self._server_artifact["state"] == "COMMITTED":
if use_after_commit:
self._api.use_artifact(
artifact_id,
artifact_entity_name=entity,
artifact_project_name=project,
)
return self._server_artifact
if (
self._server_artifact["state"] != "PENDING"
# For old servers, see https://github.com/wandb/wandb/pull/6190
and self._server_artifact["state"] != "DELETED"
):
raise Exception(
'Unknown artifact state "{}"'.format(self._server_artifact["state"])
)
manifest_type = "FULL"
manifest_filename = "wandb_manifest.json"
if incremental:
manifest_type = "INCREMENTAL"
manifest_filename = "wandb_manifest.incremental.json"
elif distributed_id:
manifest_type = "PATCH"
manifest_filename = "wandb_manifest.patch.json"
artifact_manifest_id, _ = self._api.create_artifact_manifest(
manifest_filename,
"",
artifact_id,
base_artifact_id=base_id,
include_upload=False,
type=manifest_type,
)
step_prepare = wandb.filesync.step_prepare.StepPrepare(
self._api, 0.1, 0.01, 1000
) # TODO: params
step_prepare.start()
# Upload Artifact "L1" files, the actual artifact contents
self._file_pusher.store_manifest_files(
self._manifest,
artifact_id,
lambda entry, progress_callback: self._manifest.storage_policy.store_file(
artifact_id,
artifact_manifest_id,
entry,
step_prepare,
progress_callback=progress_callback,
),
)
def before_commit() -> None:
self._resolve_client_id_manifest_references()
with tempfile.NamedTemporaryFile("w+", suffix=".json", delete=False) as fp:
path = os.path.abspath(fp.name)
json.dump(self._manifest.to_manifest_json(), fp, indent=4)
digest = md5_file_b64(path)
if distributed_id or incremental:
# If we're in the distributed flow, we want to update the
# patch manifest we created with our finalized digest.
_, resp = self._api.update_artifact_manifest(
artifact_manifest_id,
digest=digest,
)
else:
# In the regular flow, we can recreate the full manifest with the
# updated digest.
#
# NOTE: We do this for backwards compatibility with older backends
# that don't support the 'updateArtifactManifest' API.
_, resp = self._api.create_artifact_manifest(
manifest_filename,
digest,
artifact_id,
base_artifact_id=base_id,
)
# We're duplicating the file upload logic a little, which isn't great.
upload_url = resp["uploadUrl"]
upload_headers = resp["uploadHeaders"]
extra_headers = {}
for upload_header in upload_headers:
key, val = upload_header.split(":", 1)
extra_headers[key] = val
with open(path, "rb") as fp2:
self._api.upload_file_retry(
upload_url,
fp2,
extra_headers=extra_headers,
)
commit_result: concurrent.futures.Future[None] = concurrent.futures.Future()
# This will queue the commit. It will only happen after all the file uploads are done
self._file_pusher.commit_artifact(
artifact_id,
finalize=finalize,
before_commit=before_commit,
result_future=commit_result,
)
# Block until all artifact files are uploaded and the
# artifact is committed.
try:
commit_result.result()
finally:
step_prepare.shutdown()
if finalize and use_after_commit:
self._api.use_artifact(
artifact_id,
artifact_entity_name=entity,
artifact_project_name=project,
)
return self._server_artifact
def _resolve_client_id_manifest_references(self) -> None:
for entry_path in self._manifest.entries:
entry = self._manifest.entries[entry_path]
if entry.ref is not None:
if entry.ref.startswith("wandb-client-artifact:"):
client_id = util.host_from_path(entry.ref)
artifact_file_path = util.uri_from_path(entry.ref)
artifact_id = self._api._resolve_client_id(client_id)
if artifact_id is None:
raise RuntimeError(f"Could not resolve client id {client_id}")
entry.ref = URIStr(
f"wandb-artifact://{b64_to_hex_id(B64MD5(artifact_id))}/{artifact_file_path}"
)
|