This release is a pre-release and may not be stable for production use.
batchalign
TalkBank CHAT processing pipeline — ASR, forced alignment, morphosyntax
(%mor / %gra), utterance segmentation, translation, and compare.
The user-facing Python package; the runtime is a PyO3 extension backed
by the Rust crates in crates/batchalign/.
User and developer docs live in book/src/batchalign/ (the mdBook is
the source of truth). See book/src/batchalign/developer/building.md
for the canonical build recipe.
Install
From PyPI (stable wheels):
pip install batchalign
From source: use the just recipes — they go through Bazel, so
every dep (proto codegen, Rust crates, PyO3 extension, Python wheel
extras) is materialized for you. Don't reach for maturin develop or
uv sync directly unless you're debugging the build itself.
just batchalign build # build every Bazel target for batchalign
just batchalign test # run every Bazel test target
just batchalign cli --help # run `batchalign3` via the development bridge
just batchalign pytest # pytest (with full Bazel dep graph)
just batchalign wheel # host-platform wheel at python/target/wheels/
just batchalign sidecar # standalone daemon binary via PyApp
just batchalign lint # mypy (+ ruff)
just batchalign versions # source-of-truth version readout
just --list batchalign shows the full recipe list. The just
recipes call into Bazel, so tools/bazel (the bundled wrapper) takes
care of:
- regenerating the pydantic-v2 wire types from
crates/batchalign/batchalign-core/src/proto/*.rs - rebuilding the
batchalign_corePyO3 cdylib via maturin under the hood - staging the binary into the wheel
- propagating dependency changes to dependent targets
If you genuinely need bazel directly (because a recipe you want
isn't wrapped):
bazel build //... # everything
bazel test //... # everything
bazel run //book:html # static book HTML
bazel run //apps/batchalign/batchalign-gui:openapi # GUI OpenAPI codegen
The base wheel ships only the lightweight runtime. Heavy ML backends are gated behind extras — install only what you use:
pip install 'batchalign[whisper]' # Whisper ASR
pip install 'batchalign[malayalam]' # Malayalam Wav2Vec2 XLSR ASR
pip install 'batchalign[stanza]' # morphosyntax (%mor / %gra)
pip install 'batchalign[pyannote]' # optional local Pyannote backend API
pip install 'batchalign[revai]' # Rev.AI cloud ASR
pip install 'batchalign[google]' # Gemini cloud ASR + diarization
pip install 'batchalign[cantonese]' # Cantonese pipeline (FunASR, Tencent)
pip install 'batchalign[qwen3]' # Qwen3 ASR + forced aligner
pip install 'batchalign[nllb]' # NLLB translation
pip install 'batchalign[api]' # FastAPI daemon (`batchalign3 daemon`)
pip install 'batchalign[all]' # everything
CLI
batchalign3 --help
batchalign3 transcribe input_dir -o output_dir --lang eng
batchalign3 transcribe input_dir -o output_dir --lang eng --engine whisper --diarize --diarize-engine pyannote-ai
batchalign3 diarize input_dir -o output_dir --engine pyannote-ai
batchalign3 align input_dir -o output_dir --engine wav2vec
batchalign3 morphotag input_dir -o output_dir --language en
batchalign3 utseg input_dir -o output_dir
batchalign3 translate input_dir -o output_dir --target eng
batchalign3 compare input_dir gold_dir -o output_dir
batchalign3 version # banner, version, git SHA
batchalign3 cache {path,stats,clear} # local result cache
batchalign3 daemon # FastAPI server (needs [api])
When -o is omitted, results are written back in place. The CLI accepts
either a single CHAT/media file or a folder (walked recursively).
The diarization CLI defaults to pyannoteAI cloud. Select the optional local
backend with --engine pyannote (or --diarize-engine pyannote on
transcribe). Configure the cloud API key in the shared Batchalign config file
(or set BATCHALIGN_PYANNOTE_KEY):
[diarize]
engine.pyannote.key = YOUR_API_KEY
Programmatic API
import batchalign as ba
# Build a backend chain.
pipeline = ba.recipes.morphotag(
stanza_backend=ba.StanzaBackend(lang="en"),
)
# Or compose your own.
asr = ba.WhisperBackend(language=ba.LanguageCode.from_iso("eng"))
utseg = ba.CHATUtteranceBackend(model="talkbank/CHATUtterance-en")
pipeline = ba.recipes.transcribe(asr_backend=asr, utseg_backend=utseg)
# Run.
inputs = [ba.media_from_path("session.wav")]
outcomes = list(pipeline.run(inputs))
for outcome in outcomes:
outcome.write("session.cha")
Repository layout
This package is one slice of the talkbank-tools monorepo:
python/batchalign/— Python package (this file).crates/batchalign/— Rust crates (batchalign-core,batchalign-engine).crates/core/— shared CHAT parser / model / transform.apps/batchalign/batchalign-gui/— Tauri desktop GUI.book/— user + developer documentation (mdBook; source of truth).
For repo conventions, build commands, and the BA3 cutover plan, see
CLAUDE.md at the repo root and
book/src/batchalign/developer/landing-status.md.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file batchalign-0.9.0a28-cp310-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: batchalign-0.9.0a28-cp310-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 9.7 MB
- Tags: CPython 3.10+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c898f59ffdc51a3e494285d0a87584b8515d80ad9c9b511d8abcada1124182de
|
|
| MD5 |
859bca9c6013bc2270c5943dec137c74
|
|
| BLAKE2b-256 |
ce310db64deab53b295ad3eb3cf9b660fee9c807f38926deb82f130798361236
|
