Data products
Everything the toolkit can produce, with examples.
Remote catalog query
Before any local signal processing: decipher.catalog() returns
a pandas DataFrame summarising the public audio corpus, and decipher.fetch() downloads matching clips as AudioSource objects.
Loaded audio
Returned by load_audio. Float32 mono with the original sample rate.
Bandpassed audio
Zero-phase Butterworth bandpass returned as a NumPy array.
Energy envelope
Internal product of detect_units: a smoothed Hilbert or RMS
envelope in dB, plotted against the noise floor and threshold.
Detected units
A list of Unit objects, each with its own playable audio.
min_dur_s / max_dur_s parameters.Mel-patch features
Returned by mel_patch_feature: a flattened, time-normalised
log-mel patch concatenated with auxiliary scalars (duration, peak frequency,
bandwidth). One row per unit.
Embeddings
Two families:
AVESEncoder— frozen self-supervised audio embeddings (768-D per frame; pooled to a single vector viapool_meanorpool_mean_std).AutoencoderEmbedder— convolutional autoencoder with a 256-D bottleneck plus an optional decoder for spectrogram reconstruction.
Cluster result
Returned by cluster_features: HDBSCAN labels (with noise as -1),
noise-reassigned labels, the PCA-reduced feature matrix, and per-cluster centroids.
Cluster exemplars
Symbol stream and sequence statistics
Once you have a SymbolStream, the sequence module yields:
bigram_transitions.
zipf_frequency_fit.