Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Load a published v1 codec and round-trip a frame. No training dataset is require
import numpy as np
from compressionkit.runtime import load_codec

codec = load_codec("Ambiq/compressionkit-ppg-4x-v1.0")
codec = load_codec("Ambiq/compressionkit-ppg-4x-v1.1")

frame = np.zeros(codec.frame_size, dtype=np.float32) # replace with your signal frame
encoded = codec.compress(frame)
Expand All @@ -57,7 +57,7 @@ For RVQ-specific workflows that need raw token indices:
```python
from compressionkit.runtime import RVQCodec

codec = RVQCodec.from_pretrained("Ambiq/compressionkit-ecg-4x-v1.0")
codec = RVQCodec.from_pretrained("Ambiq/compressionkit-ecg-4x-v1.1")
indices = codec.encode(signal)
reconstructed = codec.decode(indices)
```
Expand Down Expand Up @@ -96,7 +96,7 @@ Choose the lightest path that answers your question:

| Goal | Command or API | Dataset required? |
|------|----------------|-------------------|
| Try a published codec | `load_codec("Ambiq/compressionkit-ppg-4x-v1.0")` | No |
| Try a published codec | `load_codec("Ambiq/compressionkit-ppg-4x-v1.1")` | No |
| Validate a local deploy package | `uv run compressionkit golden validate-deploy results/.../deploy` | No |
| Stage a HuggingFace package | `uv run compressionkit golden run <id> --skip-train --publish --dry-run` | No, if `deploy/` exists |
| Reproduce a golden run | `uv run compressionkit golden run <id>` | Yes |
Expand Down
2 changes: 1 addition & 1 deletion astro-site/migration-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -953,7 +953,7 @@
}
],
"watchedSources": {
"compressionkit/experiments/registry.py": "f5c1061d3ffbf395e7a59418e3c614f3a9e426a64543917f25cb193f03dd238f",
"compressionkit/experiments/registry.py": "352da197f1885fbf6c576e43a1ec0293d076b976639e8763f89f5adcaffc48bf",
"scripts/build_customer_evidence_summary.py": "0b851664c750874d46ad0a4b8ddcda926f4bdd141fbc63d416bbe5e592d505e2",
"scripts/build_cr_vs_fidelity.py": "191ad45d6e7a74a1380b7810a7a4fb0fff954a7487df88979e1588d5532d0bad",
"configs/ecg_rvq_256hz_02x_golden.yaml": "1df9d1fec0bf94f754eb7dcf963c6244224381d5c77cf677c9f43f53ed76ccf0",
Expand Down
2 changes: 1 addition & 1 deletion astro-site/src/content/docs/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Load a one-dimensional waveform, resample it to the codec sample rate, and follo
import numpy as np
from compressionkit.runtime import load_codec

codec = load_codec("Ambiq/compressionkit-ppg-4x-v1.0")
codec = load_codec("Ambiq/compressionkit-ppg-4x-v1.1")
fs, n = codec.sample_rate, codec.frame_size # PPG: 64 Hz

# your_signal: 1-D float32 sampled at `fs`
Expand Down
4 changes: 2 additions & 2 deletions astro-site/src/content/docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ This is useful when the encoder runs on-device and the decoder runs elsewhere.

## HuggingFace Quickstart

Published model repos follow the convention `Ambiq/compressionkit-{modality}-{cr}x-{version}`, for example `Ambiq/compressionkit-ppg-4x-v1.0` or `Ambiq/compressionkit-ecg-8x-v1.0`.
Published model repos follow the convention `Ambiq/compressionkit-{modality}-{cr}x-{version}`, for example `Ambiq/compressionkit-ppg-4x-v1.1` or `Ambiq/compressionkit-ecg-8x-v1.1`.

Install the optional Hub dependency:

Expand All @@ -207,7 +207,7 @@ def synthetic_ecg_frame(frame_size: int = 512, sample_rate: int = 256) -> np.nda
return waveform.reshape(1, 1, frame_size, 1).astype(np.float32)


codec = RVQCodec.from_pretrained("Ambiq/compressionkit-ecg-4x-v1.0")
codec = RVQCodec.from_pretrained("Ambiq/compressionkit-ecg-4x-v1.1")
signal = synthetic_ecg_frame()

indices = codec.encode(signal)
Expand Down
2 changes: 1 addition & 1 deletion astro-site/src/content/docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Each notebook exposes a single `CODEC_SOURCE` knob at the top:

```python
# A published golden codec (downloads from HuggingFace) ...
CODEC_SOURCE = "Ambiq/compressionkit-ppg-4x-v1.0"
CODEC_SOURCE = "Ambiq/compressionkit-ppg-4x-v1.1"
# ... or a local deploy package you built yourself (runs offline):
# CODEC_SOURCE = "results/ppg_rvq_64hz_04x_golden/deploy"
```
Expand Down
5 changes: 4 additions & 1 deletion astro-site/src/content/docs/experiments/ecg-rvq-16x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ecg-rvq-16x` configuration. Prepare its dataset before running th

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ecg-rvq-16x" />

<span id="dataset-license"></span>
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
5 changes: 4 additions & 1 deletion astro-site/src/content/docs/experiments/ecg-rvq-2x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ecg-rvq-2x` configuration. Prepare its dataset before running the

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ecg-rvq-2x" />

<span id="dataset-license"></span>
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
5 changes: 4 additions & 1 deletion astro-site/src/content/docs/experiments/ecg-rvq-32x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ecg-rvq-32x` configuration. Prepare its dataset before running th

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ecg-rvq-32x" />

<span id="dataset-license"></span>
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
9 changes: 6 additions & 3 deletions astro-site/src/content/docs/experiments/ecg-rvq-4x-prior.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,11 @@ Results land under `results/ecg_rvq_256hz_04x_golden/`; deploy artifacts under `

## Parent codec

The parent codec now uses corrected v1.1 exports. This prior remains on its
historical v1.0 track and has not been requalified for that release.

This entry is the entropy-prior stage paired with [`ecg-rvq-4x`](/compressionkit/experiments/ecg-rvq-4x/).
Codec and prior artifacts publish to the same HuggingFace repo
The historical codec and prior artifacts use the v1.0 HuggingFace repo
([`Ambiq/compressionkit-ecg-4x-v1.0`](https://huggingface.co/Ambiq/compressionkit-ecg-4x-v1.0)).

## Evaluation Metrics
Expand All @@ -56,12 +59,12 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.
- `prior_int8.tflite` / `prior_int8.h` / `prior_manifest.json` — entropy prior (two-stage only).

## Customization Notes

- Tweak the YAML to explore neighbouring operating points; copy the file before editing.
- For new recipes, prefer the `compressionkit/recipes/` package recipes as a starting point.
- To resume publishing without retraining, pass `--skip-train` to `compressionkit golden run ecg-rvq-4x-prior --publish`.
- Publication is blocked until the prior is requalified against its parent's corrected v1.1 release.
5 changes: 4 additions & 1 deletion astro-site/src/content/docs/experiments/ecg-rvq-4x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ecg-rvq-4x` configuration. Prepare its dataset before running the

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ecg-rvq-4x" />

<span id="dataset-license"></span>
Expand Down Expand Up @@ -55,7 +58,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.
- `prior_int8.tflite` / `prior_int8.h` / `prior_manifest.json` — entropy prior (two-stage only).

Expand Down
5 changes: 4 additions & 1 deletion astro-site/src/content/docs/experiments/ecg-rvq-64x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ecg-rvq-64x` configuration. Prepare its dataset before running th

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ecg-rvq-64x" />

<span id="dataset-license"></span>
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
9 changes: 6 additions & 3 deletions astro-site/src/content/docs/experiments/ecg-rvq-8x-prior.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,11 @@ Results land under `results/ecg_rvq_256hz_08x_golden/`; deploy artifacts under `

## Parent codec

The parent codec now uses corrected v1.1 exports. This prior remains on its
historical v1.0 track and has not been requalified for that release.

This entry is the entropy-prior stage paired with [`ecg-rvq-8x`](/compressionkit/experiments/ecg-rvq-8x/).
Codec and prior artifacts publish to the same HuggingFace repo
The historical codec and prior artifacts use the v1.0 HuggingFace repo
([`Ambiq/compressionkit-ecg-8x-v1.0`](https://huggingface.co/Ambiq/compressionkit-ecg-8x-v1.0)).

## Evaluation Metrics
Expand All @@ -56,12 +59,12 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.
- `prior_int8.tflite` / `prior_int8.h` / `prior_manifest.json` — entropy prior (two-stage only).

## Customization Notes

- Tweak the YAML to explore neighbouring operating points; copy the file before editing.
- For new recipes, prefer the `compressionkit/recipes/` package recipes as a starting point.
- To resume publishing without retraining, pass `--skip-train` to `compressionkit golden run ecg-rvq-8x-prior --publish`.
- Publication is blocked until the prior is requalified against its parent's corrected v1.1 release.
5 changes: 4 additions & 1 deletion astro-site/src/content/docs/experiments/ecg-rvq-8x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ecg-rvq-8x` configuration. Prepare its dataset before running the

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ecg-rvq-8x" />

<span id="dataset-license"></span>
Expand Down Expand Up @@ -55,7 +58,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.
- `prior_int8.tflite` / `prior_int8.h` / `prior_manifest.json` — entropy prior (two-stage only).

Expand Down
7 changes: 5 additions & 2 deletions astro-site/src/content/docs/experiments/ppg-rvq-16x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ppg-rvq-16x` configuration. Prepare its dataset before running th

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ppg-rvq-16x" />

<span id="dataset-license"></span>
Expand All @@ -18,7 +21,7 @@ Reproduce the `ppg-rvq-16x` configuration. Prepare its dataset before running th

- **Dataset**: [Open unified PPG v1](/compressionkit/datasets/) (`dataset_id: ppg-unified-strict-sanitize-v1`)
- **License**: Open (BIDMC, BUT PPG, PPG-DaLiA, WESAD — mixed open licenses, no restricted-access dependency)
- **Notes**: Sources: BIDMC, BUT PPG, PPG-DaLiA, and WESAD. Published v1 PPG goldens are MESA-free. Build the cache with `scripts/build_ppg_cache.py`.
- **Notes**: Sources: BIDMC, BUT PPG, PPG-DaLiA, and WESAD. The saved training configuration uses these open sources; complete pretraining ancestry was not independently audited in the export repair. Build the cache with `scripts/build_ppg_cache.py`.

The lifecycle runner pre-flights dataset availability before training (see the
[dataset contract](/compressionkit/api/datasets/)).
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
7 changes: 5 additions & 2 deletions astro-site/src/content/docs/experiments/ppg-rvq-2x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ppg-rvq-2x` configuration. Prepare its dataset before running the

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ppg-rvq-2x" />

<span id="dataset-license"></span>
Expand All @@ -18,7 +21,7 @@ Reproduce the `ppg-rvq-2x` configuration. Prepare its dataset before running the

- **Dataset**: [Open unified PPG v1](/compressionkit/datasets/) (`dataset_id: ppg-unified-strict-sanitize-v1`)
- **License**: Open (BIDMC, BUT PPG, PPG-DaLiA, WESAD — mixed open licenses, no restricted-access dependency)
- **Notes**: Sources: BIDMC, BUT PPG, PPG-DaLiA, and WESAD. Published v1 PPG goldens are MESA-free. Build the cache with `scripts/build_ppg_cache.py`.
- **Notes**: Sources: BIDMC, BUT PPG, PPG-DaLiA, and WESAD. The saved training configuration uses these open sources; complete pretraining ancestry was not independently audited in the export repair. Build the cache with `scripts/build_ppg_cache.py`.

The lifecycle runner pre-flights dataset availability before training (see the
[dataset contract](/compressionkit/api/datasets/)).
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
7 changes: 5 additions & 2 deletions astro-site/src/content/docs/experiments/ppg-rvq-32x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Reproduce the `ppg-rvq-32x` configuration. Prepare its dataset before running th

## Overview

The v1.1 bundle corrects the export of the existing checkpoint without retraining.
Its physiological scorecard remains historical; see [release validation](/compressionkit/rvq-v11-release/).

<ExperimentFacts id="ppg-rvq-32x" />

<span id="dataset-license"></span>
Expand All @@ -18,7 +21,7 @@ Reproduce the `ppg-rvq-32x` configuration. Prepare its dataset before running th

- **Dataset**: [Open unified PPG v1](/compressionkit/datasets/) (`dataset_id: ppg-unified-strict-sanitize-v1`)
- **License**: Open (BIDMC, BUT PPG, PPG-DaLiA, WESAD — mixed open licenses, no restricted-access dependency)
- **Notes**: Sources: BIDMC, BUT PPG, PPG-DaLiA, and WESAD. Published v1 PPG goldens are MESA-free. Build the cache with `scripts/build_ppg_cache.py`.
- **Notes**: Sources: BIDMC, BUT PPG, PPG-DaLiA, and WESAD. The saved training configuration uses these open sources; complete pretraining ancestry was not independently audited in the export repair. Build the cache with `scripts/build_ppg_cache.py`.

The lifecycle runner pre-flights dataset availability before training (see the
[dataset contract](/compressionkit/api/datasets/)).
Expand Down Expand Up @@ -50,7 +53,7 @@ The deploy package contains the following artifacts, depending on the export con
- `decoder.tflite` / `decoder.h` — decoder (float32 + optional INT8).
- `decoder.keras` — float32 Python reference decoder.
- `codebook.npz` / `codebook.h` — RVQ codebook tables.
- `sample_data.npz` — license-safe input/target/reconstruction reference frames (published to HuggingFace as `sample_stimulus.npz`).
- `sample_data.npz` — normalized synthetic inputs, targets and reconstructions; `sample_stimulus.npz` contains raw synthetic waveforms.
- `model_card.json`, `deploy_manifest.json` — metadata.

## Customization Notes
Expand Down
Loading
Loading