Skip to main content

A package for NeuCodec, based on xcodec2.

Project description

NeuCodec 🎧

HuggingFace 🤗: Model, Distilled Model

NeuCodec Intro
Click the image above to see NeuCodec in action on Youtube!

Created by Neuphonic - building faster, smaller, on-device voice AI

A lightweight neural codec that encodes audio at just 0.8 kbps - perfect for researchers and builders who need something that just works for training high quality text-to-speech models.

Key Features

🔊 Low bit-rate compression - a speech codec that compresses and reconstructs audio with near-inaudible reconstruction loss
🎼 Upsamples from 16kHz → 24kHz
🌍 Ready for real-world use - train your own SpeechLMs without needing to build your own codec
🏢 Commercial use permitted - use it in your own tools or products
📊 Released with large pre-encoded datasets - we’ve compressed Emilia-YODAS from 1.7TB to 41GB using NeuCodec, significantly reducing the compute requirements needed for training

Model Details

NeuCodec is a Finite Scalar Quantisation (FSQ) based 0.8kbps audio codec for speech tokenization. It takes advantage of the following features:

  • It uses both audio (BigCodec) and semantic (Wav2Vec2-BERT) encoders.
  • We make use of Finite Scalar Quantisation (FSQ) resulting in a single vector for the quantised output, which makes it ideal for downstream modeling with Speech Language Models.
  • At 50 tokens/sec and 16 bits per token, the overall bit-rate is 0.8kbps.
  • The codec takes in 16kHz input and outputs 24kHz using an upsampling decoder.

Our work largely based on extending the work of X-Codec2.0.

Get Started

Use the code below to get started with the model.

To install from pypi in a dedicated environment:

Using conda + pip:

conda create -n neucodec python>3.9
conda activate neucodec
pip install neucodec

Using uv:

uv venv neucodec --python 3.10
source neucodec/bin/activate  # On Windows: neucodec\Scripts\activate
uv pip install neucodec

If you would like to use the onnx decoder, also install onnxruntime:

pip install onnxruntime

Then, to use the regular codec in python:

import librosa
import torch
import torchaudio
from torchaudio import transforms as T
from neucodec import NeuCodec
 
model = NeuCodec.from_pretrained("neuphonic/neucodec")
model.eval().cuda()   
 
y, sr = torchaudio.load(librosa.ex("libri1"))
if sr != 16_000:
    y = T.Resample(sr, 16_000)(y)[None, ...] # (B, 1, T_16)

with torch.no_grad():
    fsq_codes = model.encode_code(y)
    # fsq_codes = model.encode_code(librosa.ex("libri1")) # or directly pass your filepath!
    print(f"Codes shape: {fsq_codes.shape}")  
    recon = model.decode_code(fsq_codes).cpu() # (B, 1, T_24)

torchaudio.save("reconstructed.wav", recon[0, :, :], 24_000)

Training Details

The model was trained using the following data:

  • Emilia-YODAS
  • MLS
  • LibriTTS
  • Fleurs
  • CommonVoice
  • HUI
  • Additional proprietary set

All publically available data was covered by either the CC-BY-4.0 or CC0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neucodec-0.0.4.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neucodec-0.0.4-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file neucodec-0.0.4.tar.gz.

File metadata

  • Download URL: neucodec-0.0.4.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for neucodec-0.0.4.tar.gz
Algorithm Hash digest
SHA256 994c9367b691b96c30247ebe5f3d9b7088411ff640b8df2f0dd9e1efe39f6f42
MD5 8044963bb743ebce9b6c62ecc0e52ad6
BLAKE2b-256 5e5fe948b92def28eb7d069fccc281a8c57279054a5063750742d8a62f572dda

See more details on using hashes here.

File details

Details for the file neucodec-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: neucodec-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 27.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for neucodec-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9c7c9d374d9ea92b2069953906570c748beb95e969e402c6c6a47f88ed6c17f4
MD5 60ec46b42bbff113837a5609fa7f78d7
BLAKE2b-256 543eaf493b15fd54da38cc32e9b8f0979b73c11290ef4674c180427232b509d6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page