docs: fix RVQ deploy-artifact list to use local sample_data.npz naming#61
Merged
Merged
Conversation
#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
There was a problem hiding this comment.
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.pyto document RVQ’s localsample_data.npzartifact 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
render_experiment_docs.py's "Deploy Artifacts" section otherwise describes localresults/<run>/deploy/naming (encoder.tflite,decoder.keras, etc.), but the RVQ bullet list namedsample_stimulus.npz— which is only guaranteed to exist when a package was built via thecompressionkit golden repackagepath (experiments/repackage.py), not via the normal training recipe (recipes/base_rvq.py→export_for_deployment(), which only ever writessample_data.npzlocally).sample_stimulus.npzis the correct HuggingFace-published name (RVQ_HF_FILE_RENAMESmapssample_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 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 indocs/deployment.mdanddocs/release-contract.md. The SPIHT/hybrid branch already usedsample_stimulus.npzcorrectly (that family'sexport_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