Skip to content

Artifacts: Add docs on downloading reference artifacts with checkum #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+16 −0
Open

Artifacts: Add docs on downloading reference artifacts with checkum #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2aa5548
claude writes
ngrayluna Jul 21, 2025
d7c2917
Update content/en/guides/core/artifacts/download-and-use-an-artifact.md
ngrayluna Aug 11, 2025
72416d3
Merge branch 'main' into claude_code_DOCS-1014
ngrayluna Aug 11, 2025
b497e0b
Merge branch 'main' into claude_code_DOCS-1014
ngrayluna Aug 19, 2025
65f731a
Updated
ngrayluna Aug 19, 2025
67c9e17
small edit
ngrayluna Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/en/guides/core/artifacts/construct-an-artifact.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
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.
Expand Down
12 changes: 12 additions & 0 deletions content/en/guides/core/artifacts/download-and-use-an-artifact.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ 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. To ensure your artifacts can be downloaded, use `checksum=True` (the default) when adding references:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
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):

This way the notes at least share most of the text. But if checksum=True is the default, then line 22 seems not to need the checksum=True and it might be more clear to leave it off.


```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)
```
{{% /alert %}}


### Download and use an artifact stored on W&B

Expand Down