Skip to content

docs: fix RVQ deploy-artifact list to use local sample_data.npz naming#61

Merged
apage224 merged 1 commit into
mainfrom
issue-60-fix-rvq-sample-artifact-doc
Jul 3, 2026
Merged

docs: fix RVQ deploy-artifact list to use local sample_data.npz naming#61
apage224 merged 1 commit into
mainfrom
issue-60-fix-rvq-sample-artifact-doc

Conversation

@apage224

@apage224 apage224 commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

render_experiment_docs.py's "Deploy Artifacts" section otherwise describes local results/<run>/deploy/ naming (encoder.tflite, decoder.keras, etc.), but the RVQ bullet list named sample_stimulus.npz — which is only guaranteed to exist when a package was built via the compressionkit golden repackage path (experiments/repackage.py), not via the normal training recipe (recipes/base_rvq.pyexport_for_deployment(), which only ever writes sample_data.npz locally).

sample_stimulus.npz is the correct HuggingFace-published name (RVQ_HF_FILE_RENAMES maps sample_data.npzsample_stimulus.npz), but using it in a section otherwise describing local file names was inconsistent and could reference a non-existent local file depending on which code path built the package.

Fix

Describe the actual local name (sample_data.npz, which every RVQ deploy package has regardless of build path) with a note about its HF-published name — matching the pattern already used correctly in docs/deployment.md and docs/release-contract.md. The SPIHT/hybrid branch already used sample_stimulus.npz correctly (that family's export_spiht_deploy() unconditionally writes that exact local filename, no ambiguity) — left unchanged.

Regenerated all 15 affected RVQ/two-stage experiment doc pages.

Testing

  • uv run pytest -q — 452 passed.
  • uv run ruff check . / uv run ruff format --check . — clean.
  • uv run zensical build — clean.

Closes #60

#60)

render_experiment_docs.py's "Deploy Artifacts" section otherwise
describes local results/<run>/deploy/ naming (encoder.tflite,
decoder.keras, etc.), but the RVQ bullet list named sample_stimulus.npz
-- which is only guaranteed to exist when a package was built via the
compressionkit golden repackage path (experiments/repackage.py), not
via the normal training recipe (recipes/base_rvq.py ->
export_for_deployment(), which only ever writes sample_data.npz
locally). sample_stimulus.npz IS the correct HuggingFace-published name
(RVQ_HF_FILE_RENAMES maps sample_data.npz -> sample_stimulus.npz), but
using it in a section otherwise describing local file names was
inconsistent and could reference a non-existent local file depending on
build path.

Fixed by describing the actual local name (sample_data.npz, which
every RVQ deploy package has regardless of build path) with a note
about its HF-published name, matching the pattern already used
correctly in docs/deployment.md and docs/release-contract.md. The
SPIHT/hybrid branch already used sample_stimulus.npz correctly (that
family's export_spiht_deploy() unconditionally writes that exact local
filename, no ambiguity) -- left unchanged.

Regenerated all 15 affected RVQ/two-stage experiment doc pages.

Closes #60

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Aligns the RVQ “Deploy Artifacts” documentation with the actual local deploy directory contents by listing sample_data.npz (the file written by export_for_deployment()), while still noting the HuggingFace-published rename to sample_stimulus.npz. This resolves the local-vs-published naming ambiguity described in #60.

Changes:

  • Update scripts/render_experiment_docs.py to document RVQ’s local sample_data.npz artifact with a note about its HuggingFace name.
  • Regenerate the affected RVQ experiment doc pages to reflect the corrected artifact name.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.

Show a summary per file
File Description
scripts/render_experiment_docs.py Fix RVQ deploy-artifact bullet to use local sample_data.npz and annotate HF rename.
docs/experiments/ppg-rvq-2x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ppg-rvq-4x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ppg-rvq-4x-prior.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ppg-rvq-8x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ppg-rvq-8x-prior.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ppg-rvq-16x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ppg-rvq-32x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-2x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-4x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-4x-prior.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-8x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-8x-prior.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-16x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-32x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).
docs/experiments/ecg-rvq-64x.md Regenerated deploy-artifact list to reference sample_data.npz (with HF note).

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

@apage224
apage224 merged commit f6a41ec into main Jul 3, 2026
2 checks passed
@apage224
apage224 deleted the issue-60-fix-rvq-sample-artifact-doc branch July 3, 2026 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

render_experiment_docs.py's RVQ deploy-artifact list may reference sample_stimulus.npz when only sample_data.npz exists

2 participants