From 2aa55481709500840f9b9db6c691e52fed2bf256 Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Mon, 21 Jul 2025 13:17:28 -0700 Subject: [PATCH 1/4] claude writes --- .../guides/core/artifacts/construct-an-artifact.md | 4 ++++ .../core/artifacts/download-and-use-an-artifact.md | 14 ++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/content/en/guides/core/artifacts/construct-an-artifact.md b/content/en/guides/core/artifacts/construct-an-artifact.md index 981f0d0cec..c003019c7b 100644 --- a/content/en/guides/core/artifacts/construct-an-artifact.md +++ b/content/en/guides/core/artifacts/construct-an-artifact.md @@ -173,6 +173,10 @@ Add an external URI reference to an artifact with the [`add_reference`]({{< relr artifact.add_reference(uri="uri", name="optional-name") ``` +{{% alert color="warning" %}} +**Important**: If you set `checksum=False` when adding a reference, the artifact cannot be downloaded later. Only use `checksum=False` when you need to track reference URIs without downloading capability. For downloadable artifacts, always use `checksum=True` (the default). +{{% /alert %}} + Artifacts currently support the following URI schemes: * `http(s)://`: A path to a file accessible over HTTP. The artifact will track checksums in the form of etags and size metadata if the HTTP server supports the `ETag` and `Content-Length` response headers. diff --git a/content/en/guides/core/artifacts/download-and-use-an-artifact.md b/content/en/guides/core/artifacts/download-and-use-an-artifact.md index 6ef4193e2e..f59466bf01 100644 --- a/content/en/guides/core/artifacts/download-and-use-an-artifact.md +++ b/content/en/guides/core/artifacts/download-and-use-an-artifact.md @@ -14,6 +14,20 @@ Download and use an artifact that is already stored on the W&B server or constru Team members with view-only seats cannot download artifacts. {{% /alert %}} +{{% alert color="warning" %}} +Artifacts created with reference URIs using `checksum=False` cannot be downloaded. When you add a reference to an artifact using `artifact.add_reference(..., checksum=False)`, W&B only stores the URI reference without the actual file contents or checksums. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references: + +```python +# This artifact can be downloaded +artifact.add_reference("s3://my-bucket/model.h5", checksum=True) + +# This artifact cannot be downloaded +artifact.add_reference("s3://my-bucket/model.h5", checksum=False) +``` + +Setting `checksum=True` enables W&B to track file checksums and metadata, making the artifact downloadable. While `checksum=False` speeds up artifact creation, it prevents downloading and skips iterating through reference directories. +{{% /alert %}} + ### Download and use an artifact stored on W&B From d7c29176f15c20fee11e36e8b3d72545dbc2e9bc Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Mon, 11 Aug 2025 12:07:07 -0700 Subject: [PATCH 2/4] Update content/en/guides/core/artifacts/download-and-use-an-artifact.md Co-authored-by: Amulya Musipatla <167042590+amusipatla-wandb@users.noreply.github.com> --- .../en/guides/core/artifacts/download-and-use-an-artifact.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/guides/core/artifacts/download-and-use-an-artifact.md b/content/en/guides/core/artifacts/download-and-use-an-artifact.md index f59466bf01..3cc9162015 100644 --- a/content/en/guides/core/artifacts/download-and-use-an-artifact.md +++ b/content/en/guides/core/artifacts/download-and-use-an-artifact.md @@ -15,7 +15,7 @@ Team members with view-only seats cannot download artifacts. {{% /alert %}} {{% alert color="warning" %}} -Artifacts created with reference URIs using `checksum=False` cannot be downloaded. When you add a reference to an artifact using `artifact.add_reference(..., checksum=False)`, W&B only stores the URI reference without the actual file contents or checksums. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references: +Artifacts created with reference URIs using `checksum=False` cannot be downloaded. When you add a reference to an artifact using `artifact.add_reference(..., checksum=False)`, W&B only stores the URI reference without the checksums. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references: ```python # This artifact can be downloaded From 65f731a360a9ec5e0c90826abbbd46d6b7fe4fd9 Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Tue, 19 Aug 2025 13:18:06 -0700 Subject: [PATCH 3/4] Updated --- content/en/guides/core/artifacts/construct-an-artifact.md | 2 +- .../en/guides/core/artifacts/download-and-use-an-artifact.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/guides/core/artifacts/construct-an-artifact.md b/content/en/guides/core/artifacts/construct-an-artifact.md index 8f7b375ceb..bfe9e81bdf 100644 --- a/content/en/guides/core/artifacts/construct-an-artifact.md +++ b/content/en/guides/core/artifacts/construct-an-artifact.md @@ -174,7 +174,7 @@ artifact.add_reference(uri="uri", name="optional-name") ``` {{% alert color="warning" %}} -**Important**: If you set `checksum=False` when adding a reference, the artifact cannot be downloaded later. Only use `checksum=False` when you need to track reference URIs without downloading capability. For downloadable artifacts, always use `checksum=True` (the default). +If you set `checksum=False` when adding a reference, the artifact cannot be downloaded later. Only use `checksum=False` when you need to track reference URIs without downloading capability. For downloadable artifacts, always use `checksum=True` (the default). {{% /alert %}} Artifacts currently support the following URI schemes: diff --git a/content/en/guides/core/artifacts/download-and-use-an-artifact.md b/content/en/guides/core/artifacts/download-and-use-an-artifact.md index 3cc9162015..7b7272e26d 100644 --- a/content/en/guides/core/artifacts/download-and-use-an-artifact.md +++ b/content/en/guides/core/artifacts/download-and-use-an-artifact.md @@ -15,7 +15,7 @@ Team members with view-only seats cannot download artifacts. {{% /alert %}} {{% alert color="warning" %}} -Artifacts created with reference URIs using `checksum=False` cannot be downloaded. When you add a reference to an artifact using `artifact.add_reference(..., checksum=False)`, W&B only stores the URI reference without the checksums. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references: +Artifacts created with reference URIs using `checksum=False` cannot be downloaded. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references: ```python # This artifact can be downloaded From 67c9e172ef6f664e36ec249ce12bcd3fb35ede0b Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Tue, 19 Aug 2025 13:28:07 -0700 Subject: [PATCH 4/4] small edit --- .../en/guides/core/artifacts/download-and-use-an-artifact.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/en/guides/core/artifacts/download-and-use-an-artifact.md b/content/en/guides/core/artifacts/download-and-use-an-artifact.md index 7b7272e26d..b5e76ea57d 100644 --- a/content/en/guides/core/artifacts/download-and-use-an-artifact.md +++ b/content/en/guides/core/artifacts/download-and-use-an-artifact.md @@ -24,8 +24,6 @@ artifact.add_reference("s3://my-bucket/model.h5", checksum=True) # This artifact cannot be downloaded artifact.add_reference("s3://my-bucket/model.h5", checksum=False) ``` - -Setting `checksum=True` enables W&B to track file checksums and metadata, making the artifact downloadable. While `checksum=False` speeds up artifact creation, it prevents downloading and skips iterating through reference directories. {{% /alert %}}