style: apply /style-guide pass to models/artifacts

[johndmulhausen]

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to the Models / Artifacts documentation. The run was fully automated — only style-level edits were made, and all flagged technical issues are surfaced below for human review.

Files edited

• models/artifacts/artifacts-walkthrough.mdx
• models/artifacts/construct-an-artifact.mdx
• models/artifacts/create-a-custom-alias.mdx
• models/artifacts/create-a-new-artifact-version.mdx
• models/artifacts/data-privacy-and-compliance.mdx
• models/artifacts/delete-artifacts.mdx
• models/artifacts/download-and-use-an-artifact.mdx
• models/artifacts/explore-and-traverse-an-artifact-graph.mdx
• models/artifacts/storage.mdx
• models/artifacts/track-external-files.mdx
• models/artifacts/ttl.mdx
• models/artifacts/update-an-artifact.mdx

Recommendations for technical review

Prerequisites

• Most pages lack a Prerequisites section. Consider adding one to artifacts-walkthrough.mdx, construct-an-artifact.mdx, create-a-custom-alias.mdx, create-a-new-artifact-version.mdx, download-and-use-an-artifact.mdx, explore-and-traverse-an-artifact-graph.mdx, track-external-files.mdx, ttl.mdx, and update-an-artifact.mdx listing required setup (installed wandb SDK, authenticated session, project/entity access, and any page-specific prerequisites such as cloud credentials, boto3, or an existing artifact).
• artifacts-walkthrough.mdx: the "Add the dataset to the artifact" step assumes the reader has a local dataset.h5 file. Consider linking to a sample dataset.
• ttl.mdx: the "Set or edit a TTL policy → Python SDK" snippet uses run.use_artifact(...) without a prior wandb.init(...), and the "outside of a run" snippet uses timedelta(...) without showing the from datetime import timedelta import. Confirm whether leading context should be added.

Verification steps

• Across nearly every page, code samples and procedures end without describing the expected outcome. Add brief confirmation guidance (UI cues, CLI output, lineage-graph changes, freed-space reports, etc.) after major procedures in artifacts-walkthrough.mdx, construct-an-artifact.mdx, create-a-custom-alias.mdx, create-a-new-artifact-version.mdx, delete-artifacts.mdx, download-and-use-an-artifact.mdx, explore-and-traverse-an-artifact-graph.mdx, storage.mdx, track-external-files.mdx, ttl.mdx, and update-an-artifact.mdx.
• create-a-custom-alias.mdx: after logging with best-ap50, describe where the alias appears in the W&B UI or how to verify it via the API.
• ttl.mdx: print(artifact.type) under "Autogenerated artifacts" has no expected output — clarify which value indicates an autogenerated vs. user-generated artifact.

Technical accuracy

• construct-an-artifact.mdx: the Tip block contrasts wandb.Run.log_artifact() with Artifact.save(), but Artifact.save() is never demonstrated or linked. artifact.new_file('hello.txt') appears in the API-call table without prior introduction. Verify the supported URI scheme list (http(s)://, s3://, gs://) — Azure support may be missing. Re-verify the 10,000-object cap on S3/GCS prefix expansion and the "faster uploads" rationale for async log_artifact() calls.
• create-a-custom-alias.mdx: clarify what "changed" means in the checksum/dedup sentence (are identical re-logs deduplicated?). The example artifact name run-3nq3ctyy-bike-model looks autogenerated — confirm intentional or replace. AP-50 is domain-specific; consider a more generic alias example.
• create-a-new-artifact-version.mdx: Line 58 misspells wanb.Artifact (should be wandb.Artifact). Line 21 says the retrieved artifact "has a version greater than 1" while the example progresses v0 → v1 — verify intended wording. Image alt text (Artifact workflow comparison, Incremental artifact versioning) is generic — consider more descriptive alt text.
• download-and-use-an-artifact.mdx: confirm the Pass 8 correction at line 34 that use_artifact() returns an artifact object (not a run object), and verify the placeholder explanations for [PROJECT-NAME] and [JOB-TYPE].
• explore-and-traverse-an-artifact-graph.mdx: line 93 the "inputs" cross-reference appears to be missing the #track-the-input-of-a-run fragment. Line 42 "view the type and the name of artifact" likely needs an article ("of the artifact" / "of an artifact"). Line 140 conflates two ideas and repeats "cluster" three times — consider splitting.
• storage.mdx: confirm the "To change default location set:" column header reads naturally given the cells; verify 1GB is the literal CLI argument format (vs. 1 GB / 1G); confirm "during training" framing applies outside training contexts.
• track-external-files.mdx: line 109 heading "Add and download an external from a bucket" is missing a noun. Line 7 lists "HTTP file server" as supported but no example is provided. Line 121 boto3 call uses file_name=, bucket=, object_name= — typical boto3.upload_file() parameters are Filename, Bucket, Key. Product-name inconsistency: "CoreWeave Storage and MinIO" vs. "CoreWeave AI Object Storage" — pick one. Confirm 'Object Versioning' is the literal UI label across providers. Lines 184–193 use <entity> / <project> angle-bracket placeholders rather than the [ALL-CAPS] convention preferred by CoreWeave AGENTS.md.
• ttl.mdx: lines 130 and 203 sentences end mid-thought ("expand the artifact type you"). Step 4 of "Set default TTL policies for a team" has an ambiguous trailing object ("Click the Set team's default TTL policy"). Verify the Link to registry button is still the correct landmark in the UI. Confirm createdAt field name (vs. created_at). Line 18 "permitting who can set or edit a TTL policy" reads awkwardly.
• update-an-artifact.mdx: the intro says "Use wandb.Run.save() to update an artifact," but the "During a run" example uses artifact.save() — confirm which method is correct. Confirm metadata and aliases are also updatable during a run. Verify the api.artifact_collection(type=..., collection=...) signature and whether calling wandb.Api() inside wandb.init() is intentional.

Missing content

• artifacts-walkthrough.mdx: clarify whether the final example assumes a fresh script/session, and consider explicit comments linking numbered steps to corresponding code lines.
• construct-an-artifact.mdx: gloss or link "directed acyclic graph" and PartitionedTable/PartitionTable. Step 2 says "See the next section, Add files to an artifact" but the linked target is actually Step 3. The anchor #3-save-your-artifact-to-the-w&b-server contains an unencoded &; the Mintlify slug likely strips it (probably #3-save-your-artifact-to-the-wb-server). The three H3 headings retain numbering (### 1., ### 2., ### 3.) — left as-is to preserve anchors, but worth a coordinated cleanup.
• create-a-custom-alias.mdx: add a one-line definition of "alias" up front; add cross-references to wandb.Artifact, Run.log_artifact, Run.use_artifact; reconsider the page title ("Create an artifact alias" vs. "Create a custom artifact alias").
• create-a-new-artifact-version.mdx: terms like group, wandb.Api(), use_artifact, and new_draft() are unlinked. Link the Python SDK reference. Distributed mode failure modes (e.g., finish_artifact called before all upsert_artifact calls complete, mismatched distributed_id) may warrant a Caution notice. The commented-out <Note> at lines 213–215 is dead content — restore or delete.
• data-privacy-and-compliance.mdx: define or link "soft deletion"; link directly to how to configure Dedicated Cloud retention (not just the overview); consider an inline gloss for "reference artifacts"; consider section headings (Storage / Deletion / Retention / Sensitive data).
• download-and-use-an-artifact.mdx: the W&B CLI tab needs context for when to prefer CLI over the Python API; the trailing Entry.download / Entry.ref bullets lack an outcome statement; the commented-out "Track external files" reference at line 79 should be restored or removed.
• explore-and-traverse-an-artifact-graph.mdx: the <Note> block at lines 41–43 may not warrant a notice per style guide. "Artifact clusters" should cross-link to the earlier lineage_multiple_artifact_versions.png image. Lines 7–8 and line 32 contain near-duplicate definitions of "lineage graph" — trim one.
• storage.mdx: the Warning about non-writable filesystems lacks remediation (e.g., set WANDB_DIR to a writable path). The page title mentions "memory allocation" but the body covers only disk storage and cache cleanup — narrow the title or add memory content. If non-US storage regions are available, link the region-selection docs.
• track-external-files.mdx: line 168 has an orphaned MDX comment; lines 270–280 contain a large commented-out "Log artifacts outside of runs" block — restore or remove. max_objects= (lines 82, 222) needs explanation of valid values and trade-offs. AWS_S3_ENDPOINT_URL and AWS_REGION are referenced without setup guidance.
• ttl.mdx: commented-out <Note> (lines 183–185) references a non-existent ## Inherit TTL Policy section — restore or remove. The two adjacent <Note> blocks at the top (lines 14–20) overlap and could be consolidated. Image filename typo: remove_ttl_polilcy.gif → remove_ttl_policy.gif. The ColabLink notebook URL points to a feature branch (kas-artifacts-ttl-colab) rather than master — verify reachability.
• update-an-artifact.mdx: link "Model Registry" and define "linked" in the Model Registry warning; clarify when an artifact is "active" vs. when to use the Public API; the "Artifacts Collection" link text targets a generic Public API reference — confirm or update.

Placeholder and naming conventions

• Multiple files mix placeholder styles ([MY-PROJECT-NAME] vs. [MY-PROJECT] vs. [PROJECT]; [MY-ARTIFACT-NAME] vs. [ARTIFACT]; <entity> angle-bracket vs. [ENTITY] bracket). Consider a coordinated cleanup to standardize on one convention (for example, [ENTITY], [PROJECT], [ARTIFACT], [ALIAS], [TYPE]).
• construct-an-artifact.mdx: "W&B server" appears lowercase in two headings but "W&B Server" appears as a proper noun elsewhere — confirm whether headings refer to the self-managed Server product or to the backend generically. "W&B Runs" as a linked first mention may warrant lowercasing per the "features become lowercase" rule.

How to review

• Each file's changes are style edits only. Compare side-by-side and flag any that change technical meaning.
• Approve and merge to accept the edits, or close to reject them.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
wandb	🟢 Ready	View Preview	Jun 3, 2026, 9:11 PM

[github-actions]

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (12 total)

📄 Pages (12)

File	Preview
models/artifacts/artifacts-walkthrough.mdx	Artifacts Walkthrough
models/artifacts/construct-an-artifact.mdx	Construct An Artifact
models/artifacts/create-a-custom-alias.mdx	Create A Custom Alias
models/artifacts/create-a-new-artifact-version.mdx	Create A New Artifact Version
models/artifacts/data-privacy-and-compliance.mdx	Data Privacy And Compliance
models/artifacts/delete-artifacts.mdx	Delete Artifacts
models/artifacts/download-and-use-an-artifact.mdx	Download And Use An Artifact
models/artifacts/explore-and-traverse-an-artifact-graph.mdx	Explore And Traverse An Artifact Graph
models/artifacts/storage.mdx	Storage
models/artifacts/track-external-files.mdx	Track External Files
... and 2 more files

---

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: ab69750 at 2026-06-05 20:55:32 UTC

[github-actions]

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-models-artifacts-20260603-165211.mintlify.app

[Copilot]

Pull request overview

This PR applies automated style-guide edits across the Models → Artifacts documentation set, primarily improving wording consistency, headings, and adding frontmatter keywords to support discoverability.

Changes:

• Added keywords metadata and refined intros/notes for clarity and consistency across multiple Artifacts docs pages.
• Standardized placeholder formatting in many code examples (toward bracketed placeholders) and tightened procedural language.
• Restructured some sections/headings (for example, converting subheadings to top-level sections where appropriate).

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
models/artifacts/artifacts-walkthrough.mdx	Reworded walkthrough steps and improved narrative flow; added keywords.
models/artifacts/construct-an-artifact.mdx	Clarified construction steps and examples; added keywords; updated tables and links.
models/artifacts/create-a-custom-alias.mdx	Refined alias explanation and placeholder formatting; added keywords.
models/artifacts/create-a-new-artifact-version.mdx	Expanded explanations for single/distributed/incremental versioning; added keywords.
models/artifacts/data-privacy-and-compliance.mdx	Improved framing around storage, deletion, and retention; added keywords.
models/artifacts/delete-artifacts.mdx	Improved explanations around soft-delete/GC and deletion flows; added keywords.
models/artifacts/download-and-use-an-artifact.mdx	Updated terminology/formatting and added keywords; clarified use_artifact() return type.
models/artifacts/explore-and-traverse-an-artifact-graph.mdx	Improved lineage graph explanation, placeholders, and navigation language; added keywords.
models/artifacts/storage.mdx	Added keywords; adjusted cache cleanup section formatting.
models/artifacts/track-external-files.mdx	Clarified reference artifact behavior and external storage guidance; added keywords.
models/artifacts/ttl.mdx	Reworked TTL overview and procedures; added keywords; updated placeholders and UI steps.
models/artifacts/update-an-artifact.mdx	Refined intro and examples; added keywords; improved wording around API vs in-run updates.

Comments suppressed due to low confidence (1)

models/artifacts/ttl.mdx:177

• The "outside of a run" example uses wandb.Api() and timedelta(...) but doesn't import wandb or timedelta, so it won't run as-is.

api = wandb.Api()

artifact = api.artifact("[ENTITY]/[PROJECT]/[ARTIFACT]:[ALIAS]")

artifact.ttl = timedelta(days=365)  # Delete in one year

artifact.save()

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[johndmulhausen]

Addressed review feedback in ab69750

Thanks for the review! I incorporated all 15 inline comments plus the suppressed low-confidence comment, and replied inline on each thread. Summary:

Technical accuracy / runnable examples

• update-an-artifact: in-run updates now use the wandb.Artifact class + Artifact.save() (not wandb.Run.save()).
• explore-and-traverse: use_artifact now uses the canonical name:alias form instead of aliases="<string>".
• create-a-new-artifact-version: corrected "version greater than 1" → "already has at least one version (v0 or later)".
• ttl: the four Python snippets that referenced an undefined run are now wrapped in with wandb.init(...) as run:, and the out-of-run example gained its import wandb / from datetime import timedelta lines (this also covers the suppressed low-confidence comment on the out-of-run snippet).
• construct-an-artifact: the add_dir example now uses a directory path.

Links / anchors / metadata

• construct-an-artifact: fixed the & in the "save your artifact" anchor → #3-save-your-artifact-to-the-wb-server.
• explore-and-traverse: "inputs" cross-reference now points to #track-the-input-of-a-run.
• download-and-use-an-artifact: keyword wandb.Api (was "wandb Api").
• storage: dropped "memory allocation" from the title/description since the body only covers disk storage + cache cleanup.

Wording / consistency

• ttl: completed the two truncated W&B App steps.
• explore-and-traverse: added the missing article ("the name of an artifact").
• track-external-files: standardized on "CoreWeave AI Object Storage".

I also fixed two clear errors flagged in the PR description while I was in those files: the wanb.Artifact typo (create-a-new-artifact-version) and the truncated heading "Add and download an external file from a bucket" (track-external-files).

Left for technical/SME review (as the PR description requests): the deeper product-accuracy questions (e.g., the 10,000-object prefix cap, Azure URI support, the boto3 parameter names, createdAt vs created_at), the proposed Prerequisites/verification-step additions, and the cross-file placeholder standardization. I also intentionally left the remove_ttl_polilcy.gif filename as-is: the asset on disk uses that spelling, so renaming only the reference would break the image — that one needs a coordinated rename of the file plus its en/ja/ko/fr references.