Skip to main content

Forced alignment pipeline designed for efficiency and ease of use.

Project description

Easier forced alignment with easyaligner

image

easyaligner is a fast and memory efficient forced alignment pipeline for speech and text. Given a text transcript, easyaligner will help identify where each word or phrase was spoken in the audio. The library supports aligning both from ground-truth transcripts, as well as from ASR-generated transcripts (easyaligner acts as the backend that powers alignment in easytranscriber). Some notable features of easyaligner include:

  • GPU accelerated forced alignment. Uses Pytorch's forced alignment API with a GPU based implementation of the Viterbi algorithm. Enables fast and memory-efficient forced alignment of long audio segments (Pratap et al., 2024).
  • Flexible text normalization for improved alignment quality. Users can supply custom regex-based text normalization functions to preprocess transcripts before alignment. A mapping from the original text to the normalized text is maintained internally. All of the applied normalizations and transformations are consequently non-destructive and reversible after alignment.
  • Batch processing support for emission extraction. easyaligner supports batched inference for wav2vec2-based models, keeping track of non-padded logits when doing alignment.

Check out the documentation for more details and tutorials!

Installation

With GPU support (recommended)

pip install easyaligner --extra-index-url https://download.pytorch.org/whl/cu128

[!TIP]
Remove --extra-index-url if you want a CPU-only installation.

Using uv

When installing with uv, it will select the appropriate PyTorch version automatically (CPU for macOS, CUDA for Linux/Windows/ARM):

uv pip install easyaligner

Usage

The example below downloads a short snippet from a LibriVox audiobook recording of A Tale of Two Cities. The snippet is 57 seconds long, and corresponds to the first paragraph of the first chapter of A Tale of Two Cities. The corresponding text to be used for alignment is directly supplied below and assigned to the text variable.

from pathlib import Path

from transformers import (
    AutoModelForCTC,
    Wav2Vec2Processor,
)
from huggingface_hub import snapshot_download

from easyaligner.text import load_tokenizer
from easyaligner.data.datamodel import SpeechSegment
from easyaligner.pipelines import pipeline
from easyaligner.text import text_normalizer
from easyaligner.vad.pyannote import load_vad_model

filepath_pattern = "tale-of-two-cities_align-en/taleoftwocities_01_dickens_64kb_align.mp3"

# Download mp3 from Hugging Face Hub
snapshot_download(
    "Lauler/easytranscriber_tutorials",
    repo_type="dataset",
    local_dir="data/tutorials",
    allow_patterns=filepath_pattern,
)

# File(s) to align
filepath = Path("data/tutorials") / filepath_pattern
audio_dir = filepath.parent
audio_files = [filepath.name]

text = """
It was the best of times, it was the worst of times, it was the age of
wisdom, it was the age of foolishness, it was the epoch of belief, it
was the epoch of incredulity, it was the season of Light, it was the
season of Darkness, it was the spring of hope, it was the winter of
despair, we had everything before us, we had nothing before us, we were
all going direct to Heaven, we were all going direct the other way--in
short, the period was so far like the present period, that some of its
noisiest authorities insisted on its being received, for good or for
evil, in the superlative degree of comparison only.
"""

text = text.strip()

# The alignments will be organized according to how the text is tokenized
tokenizer = load_tokenizer(language="english")  # sentence tokenizer
span_list = list(tokenizer.span_tokenize(text))  # start, end character indices for each sentence
speeches = [[SpeechSegment(speech_id=0, text=text, text_spans=span_list, start=None, end=None)]]

# Load models and run pipeline
model_vad = load_vad_model()
model = AutoModelForCTC.from_pretrained("facebook/wav2vec2-base-960h").to("cuda").half()
processor = Wav2Vec2Processor.from_pretrained("facebook/wav2vec2-base-960h")

pipeline(
    vad_model=model_vad,
    emissions_model=model,
    processor=processor,
    audio_paths=audio_files,
    audio_dir=audio_dir,
    speeches=speeches,
    alignment_strategy="speech",
    text_normalizer_fn=text_normalizer,
    tokenizer=tokenizer,
    start_wildcard=True,
    end_wildcard=True,
    blank_id=processor.tokenizer.pad_token_id,
    word_boundary="|",
)

[!TIP] easyaligner allows organizing the output at any level of granularity the user wishes (sentence, paragraph, or other). In the above example, we use an nltk.tokenize.punkt.PunktTokenizer to sentence tokenize our text. See the text processing documentation for a more detailed explanation, and a tutorial for implementing custom tokenizers.

Documentation

Check out the documentation tutorials that cover common scenarios for forced alignment, and the API reference:

  • https://kb-labb.github.io/easyaligner/
  • Tutorial 1: Align text and audio when the transcript covers all of the spoken content in the audio.
  • Tutorial 2: Transcript covers only part of the spoken content in the audio, but we know the relevant audio region in advance.
  • Tutorial 3: Transcript covers only part of the spoken content in the audio, and we don't know the relevant audio region in advance.

Outputs

By default, easyaligner saves the outputs of each stage of the pipeline (VAD, emission extraction, forced alignment) as JSON files in separate directories. The final aligned output can be found in output/alignments. The directory structure after running the full pipeline will look as follows:

output
├── alignments
├── emissions
└── vad

The output/emissions directory will, in addition to the JSON files, also contain output emissions for each JSON file in .npy format.

All intermediate files can safely be deleted, assuming there is no need to re-run the pipeline from a specific intermediate stage.

Citation

If you use easyaligner in your research, consider citing the following blog post:

@online{rekathati2026,
  author = {Rekathati, Faton},
  title = {Easyaligner: {Forced} Alignment of Text and Audio, Made Easy},
  date = {2026-04-08},
  url = {https://kb-labb.github.io/posts/2026-04-08-easyaligner/},
  langid = {en}
}

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

easyaligner-0.3.1.tar.gz (44.9 kB view details)

Uploaded Source

Built Distribution

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

easyaligner-0.3.1-py3-none-any.whl (48.9 kB view details)

Uploaded Python 3

File details

Details for the file easyaligner-0.3.1.tar.gz.

File metadata

  • Download URL: easyaligner-0.3.1.tar.gz
  • Upload date:
  • Size: 44.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for easyaligner-0.3.1.tar.gz
Algorithm Hash digest
SHA256 dcad40ecf151bce15aa09111e30abf6f638b851e1a5656992f0da183d9ba60be
MD5 572efbb3bc922bbc2d30152c66574b3b
BLAKE2b-256 15a5219d33959a193c3db7991a156fe605d3ee88c331d17827bb877dcc3c21aa

See more details on using hashes here.

File details

Details for the file easyaligner-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: easyaligner-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 48.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for easyaligner-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebb88249a0f221c52ff5491e42fd07d42f00b506c5a004230a855d9cf7fc6fbc
MD5 d0899167e36c6da480eb9fc94eb82537
BLAKE2b-256 37b3db0b70f6f2c93bda82d8c47589f29319e082279c6773c695a61f337cdee1

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