Skip to content
compressionKIT
Reference
HELIA

Python API catalog

Search classes and functions by name or module. Documentation is generated from the Python source without importing training dependencies.

93 of 93 APIs

Search Python API
NameDescription
AugmentationConfigConfigurable augmentation and abstention regimes applied in training.
AugmentationConfigTier-1 PPG augmentation settings for cross-domain robustness.
BandMetricsConfigBand-limited evaluation configuration.
BandMetricsConfigBand-limited evaluation configuration.
bandpass_filter_batchApply a physiokit bandpass filter across a batch of signals.
BetaAnnealConfigSchedule for the RVQ commitment-loss weight (beta).
build_augmenterCreate augmentation pipeline.
build_decoder_2dBuild a configurable decoder that mirrors the encoder stages.
build_decoder_2d_spatialBuild a 2-D spatial decoder that mirrors the spatial encoder.
build_decoder_2d_ssmDecoder that mixes time with diagonal SSM blocks at every spatial scale.
build_encoder_2dBuild a configurable encoder with ``2**num_stages`` downsampling.
build_encoder_2d_invresEncoder using inverted-residual blocks with optional causal padding.
build_encoder_2d_spatialBuild a 2-D spatial encoder for spectrogram inputs.
build_hierarchical_adaptor_decoder_2dBuild a summed-latent decoder with per-level residual adaptors.
build_hierarchical_decoder_2dBuild a coarse + residual/detail decoder for per-level RVQ tensors.
build_ppg_tfrecord_cacheBuild a subject-split TFRecord cache for PPG windows.
build_preprocessorCreate preprocessing pipeline: random crop + layer normalization.
build_rvq_autoencoderBuild encoder, bottleneck, decoder, and composite VQAutoencoder.
build_rvq_autoencoder_2d_spatialBuild 2-D spatial RVQ autoencoder for STFT spectrograms.
CacheConfigConfig for TFRecord cache dataset mode.
CacheConfigConfig for TFRecord cache dataset mode.
CodecUniform runtime interface for compressionKIT codecs.
collect_random_samplesGrab a subset of (input, target) tensors from a tf.data pipeline.
CompressionResult`dataclass`
compute_compression_statsCompute compression ratio and related statistics.
compute_ecg_hr_hrvDetect R-peaks and compute HR/HRV from a single ECG signal.
compute_ppg_physiokit_metricsCompute HR/HRV metrics for one PPG signal using physiokit.
compute_signal_metricsCompute scalar reconstruction metrics on two aligned signals.
DataConfigData loading and preprocessing configuration.
DataConfigData loading and preprocessing configuration.
DerivativeLossConfigFirst-derivative (smoothness) penalty on reconstruction.
DerivativeLossConfigFirst-derivative (smoothness) penalty on reconstruction.
DwtLossConfigFrequency-weighted MSE via Haar DWT subbands.
EcgRvqConfigTop-level configuration for ECG RVQ training pipeline.
EncodedFrame`dataclass`
EntropyPriorLightweight entropy prior using a causal CNN TFLite model.
EvaluationConfigPost-training evaluation configuration.
EvaluationConfigPost-training evaluation configuration.
export_decoder_tfliteExport decoder to INT8 TFLite and C header.
export_denoiser_tfliteExport a wavelet-gain denoiser to INT8 TFLite and C header.
export_encoder_tfliteExport encoder to INT8 TFLite and C header using helia_edge.
FilterConfigConfig for bandpass filtering of input or target signals.
FilterConfigConfig for bandpass filtering of input or target signals.
FilteredLossConfigLowpass-filtered MSE to focus on frequencies the model can represent.
generate_synthetic_ppg_batchGenerate synthetic PPG segments via physiokit.
HierarchicalRVQAutoencoderRVQ autoencoder that routes per-level RVQ tensors to the decoder.
HybridSpihtCodecLearned-denoiser + SPIHT runtime loaded from a deploy directory.
LabelTrustConfigReference-free label-trust loss weighting (``n0``-aware strong/weak labels).
load_codecHydrate a codec from a local deploy directory or HF repo id.
load_ppg_datasetLoad multiple EDF files into a stacked numpy array ``[N, num_samples]``.
load_ppg_file_splitsReturn train/val/test EDF file splits for subject-level separation.
load_ppg_signalLoad a single PPG signal from an EDF file, resampling to *target_rate*.
load_ppg_splitsLoad train/val/test numpy arrays of resampled PPG signals.
LongRecordingEvalConfigLong-recording overlap-add evaluation for clinically meaningful HR/HRV.
LrScheduleConfigLearning rate schedule configuration.
LrScheduleConfigLearning rate schedule configuration.
make_ppg_inmemory_datasetBuild a tf.data pipeline from in-memory numpy arrays.
make_ppg_stream_datasetBuild a streaming tf.data dataset that samples random windows per subject.
make_ppg_tfrecord_datasetBuild dataset from TFRecord windows compatible with RVQ trainer.
ModelConfigRVQ autoencoder model architecture configuration.
ModelConfigRVQ autoencoder model architecture configuration.
OutputConfigOutput directory and logging configuration.
OutputConfigOutput directory and logging configuration.
PhysiokitMetricsConfigPhysioKit HR/HRV evaluation configuration.
PpgRvqConfigTop-level configuration for PPG RVQ training pipeline.
PRDPercent RMS difference metric with optional energy normalization.
PrefixSupervisedVQAutoencoderVQ autoencoder with auxiliary coarse-to-fine RVQ prefix losses.
resolve_deploy_dirReturn a local deploy directory, downloading from HF if needed.
RVQCodecLightweight RVQ autoencoder codec using LiteRT for inference.
RvqPrefixLossConfigAuxiliary coarse-to-fine supervision for multi-level RVQ prefixes.
save_sample_artifactsSave per-sample CSV, plot, and compute metrics for one evaluation sample.
SpectralLossConfigMulti-scale spectral loss for frequency-domain reconstruction quality.
SpectralLossConfigMulti-scale spectral loss for frequency-domain reconstruction quality.
SpihtCodecThin runtime wrapper around :class:`SpihtAcCodec`.
SpihtCodecConfigTyped codec parameters for SPIHT.
StitchingEvalConfigLong-recording stitching evaluation.
StreamingConfigConfig for subject-level streaming dataset mode.
StreamingConfigConfig for subject-level streaming dataset mode.
summarize_ecg_alignmentCompare ECG HR/HRV/peak-timing between paired original and reconstructed signals.
summarize_physiokit_alignmentCompare physiokit HR/HRV metrics between original and reconstructed signals.
summarize_ppg_peak_alignmentCompare PPG pulse peak timing between paired original/reconstructed signals.
SyntheticMixConfigConfig for synthetic ECG mixing during training.
SyntheticMixConfigConfig for synthetic PPG mixing during in-memory training.
TrainingConfigTraining hyperparameters and schedule configuration.
TrainingConfigTraining hyperparameters and schedule configuration.
TransformConfigSignal transform domain for compression input.
TransformConfigSignal transform domain for compression input.
TruePRDNormalized PRD metric (convenience alias).
TwoStageCodecTwo-stage compression: RVQ codec + entropy-coded prior.
UnifiedCacheConfigConfig for unified per-source TFRecord cache dataset mode.
UnifiedSourceConfigOne source in a unified multi-source training mix.
WandbConfigWeights & Biases logging configuration.
WandbConfigWeights & Biases logging configuration.