compact-alignments — per-verse, per-book, content-addressed

The token-position companion to lexeme-alignments (which is aggregated/type-level and can't tell you what happened in any one verse). This dataset restores position: for a given edition's Bible book, which Hebrew/Greek content word aligned to which target-text token, verse by verse.

The authoritative list of what's published is always manifest.json, not this file.

Original-language source editions (needed to resolve srcOrd)

srcOrd (in the compact string, below) is an ordinal among a verse's Hebrew/Greek content lexemes (the same MACULA lexeme anchor lexeme-alignments uses — see below) — to turn it back into an actual source word, a client needs the SAME fixed original-language edition this project aligns against, for both testaments:

testament	edition	source
Hebrew (OT)	WLC (Westminster Leningrad Codex)	Clear-Bible macula-hebrew@main
Greek (NT)	Nestle1904	Clear-Bible macula-greek@main

Same editions lexeme-alignments anchors against — see that dataset's README for detail.

What this is not

It does not contain any Bible text. Every entry is a pair of integers (an ordinal and a target token position) — no words, no verse text, nothing copyrightable. To turn a compact string back into words you need the edition's own text (tokenized the same way alignment tokenized it), obtained separately from that edition's own source. This is deliberate: it's what keeps the dataset unambiguously CC0 and small.

Two kinds of file

1. Shared content-lexeme sequence — _index/<BOOK>_lexemes.json, published ONCE per book

{"RUT 1:1": ["1961", "3117", "8199", "8199", "1961", "7458", "0776", ...], ...}

The only shared index — this dataset does NOT also publish a separate flat ["BOOK C:V", ...] ref list. That would be pure redundancy: this object's own (ordered) keys already are that list, so a client derives it in one line rather than downloading a second, duplicate file (see below).

srcOrd[i] in a compact string (file kind #2) is the lexeme at position i in the value here — resolved for you, no morphology knowledge required. Lexemes are published without the hbo:/grc: language prefix that lexeme-alignments uses (hbo:0430 → plain 0430) — redundant here specifically, because a BOOK is always entirely one testament (Hebrew OT or Greek NT, never mixed), so the book code itself already tells you which language every entry in the file is. (Don't drop the prefix anywhere it might mix testaments, e.g. lexeme-alignments — one partition there spans a whole language, both OT and NT.)

srcOrd cannot be resolved from file kind #2 alone — you always need this file too. It exists specifically so a client never has to reconstruct is_content themselves. Live case that motivated it: Hebrew's direct-object marker (Strong's H0853) shares its bare lexeme id with a much rarer noun homonym — nothing in the lexeme or Strong's code alone distinguishes them, in EITHER our spine or a typical external lexicon. is_content in our own pipeline isn't derived from lexeme/Strong's either — it comes from a per-occurrence morphological class tag (MACULA class: noun/verb/adjective vs particle/etc.) — so we resolve it once, here, and publish the answer rather than asking every client to independently re-derive it from their own morphology data and hope it agrees with ours. Concrete check, GEN 1:1 ("In the beginning God created the heavens and the earth"): the verse has 7 Hebrew tokens including two occurrences of H0853 (the object marker, before "heavens" and before "earth") — _index/GEN_lexemes.json["GEN 1:1"] lists exactly 5 lexemes (7225 beginning, 1254 create, 0430 God, 8064 heavens, 0776 earth) — both 0853 occurrences correctly excluded, with nothing beyond an array lookup required to know that.

Edition-independent — written once, the first time any edition publishes that book, every subsequent edition just reuses it. See the pooled-range caveat in compact_align.py's build_source_lexemes docstring if you're decoding a PKF-style pooled target-verse range (rare).

2. Per-edition, per-book compact array — <iso[0]>/<iso>/<edition>/<BOOK>_<hash>.json

["0:1 1:2 2:5 3:5-6 4:12 5:10 6:13 7:16 8:17 9:19 10:21 11:30 12:33 13:35 14:24 15:27",
 "0:3 1:1 2:5 3:9 4:7 5:11 6:14 7:18 8:20 9:22 10:24-25 11:27 12:29 13:32 14:34 15:36 16:38",
 "0:5 1:4 2:3 3:1 4:9 5:13",
 ...]

Same length as that book's _lexemes.json, position-parallel to its keys — array element i is the compact string for the i-th verse ref (in _lexemes.json's own key order). No verse-ref keys stored per edition.

Deriving the ref list — one line, either language

Since the ref list is just _index/<BOOK>_lexemes.json's own ordered keys, don't fetch/store it separately — derive it from the same file you already need for lexemes:

Python:

import json
lexemes = json.loads(open("_index/RUT_lexemes.json").read())
refs = list(lexemes.keys())                          # ["RUT 1:1", "RUT 1:2", "RUT 1:3", ...]
array = json.loads(open("e/eng/eng_BSB/RUT_101a1.json").read())
by_ref = dict(zip(refs, array))

by_ref["RUT 1:1"]        # -> "0:1 1:2 2:5 3:5-6 4:12 5:10 6:13 7:16 8:17 9:19 10:21 11:30 12:33 13:35 14:24 15:27"
lexemes["RUT 1:1"][0]    # -> "1961"  (the lexeme srcOrd 0 refers to)

JavaScript:

const lexemes = JSON.parse(await fetch("_index/RUT_lexemes.json").then(r => r.text()));
const refs = Object.keys(lexemes);                    // ["RUT 1:1", "RUT 1:2", "RUT 1:3", ...]
const array = JSON.parse(await fetch("e/eng/eng_BSB/RUT_101a1.json").then(r => r.text()));
const byRef = Object.fromEntries(refs.map((ref, i) => [ref, array[i]]));

byRef["RUT 1:1"];         // -> "0:1 1:2 2:5 3:5-6 4:12 5:10 6:13 7:16 8:17 9:19 10:21 11:30 12:33 13:35 14:24 15:27"
lexemes["RUT 1:1"][0];    // -> "1961"  (the lexeme srcOrd 0 refers to)

(Object.keys()/for...in iterate string keys in insertion order per the ECMAScript spec since ES2015 — this is guaranteed, not just conventional, in modern JS. Same guarantee in Python 3.7+ dicts.)

Path components

<iso[0]>/<iso>/<edition>/<BOOK>_<hash>.json

segment	meaning	example
<iso[0]>	first character of the ISO 639-3 code — a sharding bucket, nothing more	e (for eng)
<iso>	the TRUE published language code	eng
<edition>	which edition/translation of that language, iso-prefixed unless it already carries one	eng_BSB, arb_vdv
<BOOK>	3-letter USFM book code	RUT
<hash>	last 5 hex chars of that book's content hash (below)	101a1

<edition> comes from the same identifier already published as base_text in lexeme-alignments — so a consumer of both datasets can join on it directly.

The compact string format

"0:1 1:2 2:5 3:5-6 4:12 5:10 6:13 7:16 8:17 9:19 10:21 11:30 12:33 13:35 14:24 15:27"

srcOrd counts lexemes, not raw source tokens — the SAME MACULA lexeme anchor (lang:augmented-strong, e.g. hbo:0430) lexeme-alignments uses, not a bare Strong's number or a raw word count. See lexeme-alignments' "The anchor: lexeme, not Strong's" section for what that means and why (homonym/sense-split handling, the Strong's rollup, etc.) — this dataset assumes that anchor as given rather than re-explaining it. (On GitHub, the same section lives at lexeme-alignments/README.md.)

token	meaning
space	separates entries — one per aligned content lexeme (the lexeme anchor above)
srcOrd:targetSpan	srcOrd = 0-based ordinal among that verse's content lexemes ONLY, in source order (function words never get an ordinal)
- inside a span	a contiguous range of target-token positions, inclusive (3-4 = tokens 3 and 4)
, inside a span	a scattered, non-contiguous list of target-token positions — see the worked example below
bare integer	one single target token
(ordinal absent)	that content lexeme is unaligned in this edition — no null placeholder
"" (empty string)	the verse has no aligned content lexeme, or the edition has no text there (e.g. a non-anchor verse of a pooled translation range)

Target token positions are addressed by position in that verse's own tokenized text — a consumer tokenizes the edition's text the SAME way alignment did to resolve a position back to a word, or target positions silently point at the wrong words. This is NOT plain whitespace/punctuation splitting — the exact rule (usj_source.tokenize()) is: a token is a maximal run of Unicode letters + combining marks (categories L/M). Everything else — punctuation, whitespace, AND digits (Nd, e.g. 40, 3) — is a separator, producing NO token at all, not even a placeholder. Numerals in the source text are the sharpest gotcha: a naive re-tokenizer that treats "Selama 40 hari" as 3 tokens (Selama, 40, hari) will be off-by-one from every position onward, compounding for every subsequent number in the verse — this alone can look exactly like a systematic alignment bug when it's actually a tokenization mismatch (verified against real client feedback on ACT 1:3/ind_ags: 8 apparent "off-by-one" mismatches collapsed to 2 genuine ones once decoded with the correct tokenizer rule).

Reference implementation, both languages (verified byte-for-byte identical to usj_source.tokenize() on the real ind_ags ACT 1:3 text above):

Python:

import unicodedata

def tokenize(text: str) -> list[str]:
    toks, cur = [], []
    for ch in unicodedata.normalize("NFC", text):
        if unicodedata.combining(ch):          # drop non-spacing combining marks (Hebrew niqqud,
            continue                           # Arabic harakat, ...) before the letter/mark test below
        if unicodedata.category(ch)[0] in ("L", "M"):
            cur.append(ch)
        elif cur:
            toks.append("".join(cur))
            cur = []
    if cur:
        toks.append("".join(cur))
    return toks

JavaScript (covers Latin/Cyrillic/Greek-script targets, which is the large majority — see the caveat below for diacritic-heavy scripts):

function tokenize(text) {
    const normalized = text.normalize("NFC");
    return normalized.match(/[\p{L}\p{M}]+/gu) || [];   // \p{L}=letter, \p{M}=mark (Unicode property escapes)
}

Honest caveat on the JS version: JavaScript has no built-in equivalent to Python's unicodedata.combining() (canonical combining class), so the snippet above doesn't strip non-spacing marks (Mn) the way the Python one does — it's exactly right for scripts without those (Latin, Cyrillic, Greek — covers most target languages, including the ind_ags case here), but for a diacritic-heavy script (Hebrew niqqud, Arabic harakat, Devanagari) it may tokenize slightly differently than usj_source.tokenize(). Rather than ship a JS mark-stripping table that could itself be subtly wrong, if you're decoding one of those scripts, treat usj_source.py's Python implementation as the authoritative reference.

Worked example — the scattered (comma) case

Real output, RUT 1:11, English (BSB):

"0:2 1:1 2:3 3:4,6 4:10 5:16 6:19 8:23"

Verse text: "But Naomi replied, "Return home, my daughters. Why would you go with me?..."

ordinal	Hebrew	Strong's	span	decoded
0	תֹּ֤אמֶר	H0559	2	replied
1	נָעֳמִי֙	H5281	1	Naomi
2	שֹׁ֣בְנָה	H7725	3	Return
3	בְנֹתַ֔	H1323	4,6	home, daughters (scattered — token 5, "my", is skipped in between)
4	תֵלַ֖כְנָה	H1980	10	go

This is genuine eflomal output, not a contrived case: the aligner linked "daughters" to two non-adjacent English words. The comma form exists precisely to represent real cases like this — a contiguous "a-b" range would be wrong here (it would also claim token 5, "my", which this Hebrew word did not align to).

The content hash — reproducible by ANY client, in any text format

Alignment is extremely sensitive to any wording difference in a revised Bible book. If a publisher fixes a typo or re-versifies a chapter, an alignment computed against the OLD text is silently wrong against the new one. The hash in the filename turns that into a fail-closed lookup: a client hashes its OWN copy of the edition's book text and looks for a matching filename — no match means no stale alignment can be served by accident.

Algorithm (book_content_hash in compact_align.py — reimplementable in any language):

1. Extract every verse's translatable text only (no footnotes, headings, or titles — the same rule alignment itself follows).
2. For each (chapter, verse) pair, ascending, form the string "{chapter}:{verse}:{text}".
3. Join all of a book's verse-strings with "\n".
4. UTF-8 encode.
5. SHA-256, hex digest.
6. The filename uses the last 5 hex characters (a client wanting stronger collision resistance can still recompute and compare the full 64-char digest — only the filename is truncated).

Including chapter:verse in the hashed string (not just the bare words) means a re-versification (a verse split, merge, or renumbering) changes the hash too, even when every word stayed the same — a re-versified book needs a fresh alignment exactly as much as a reworded one does.

This is deliberately based on the extracted words, never the container format (USJ/USFM/plain-text JSON bytes) — verified: re-serializing identical content with different JSON formatting keeps the hash unchanged; changing a single word anywhere in the book changes it.

Layout — why the bulk data isn't in git

compact-alignments/
  README.md              # committed — this file
  manifest.json           # committed — per-language/edition metadata (the durable record)
  _index/                 # committed — small (~tens of KB total), generated once, never edition-specific
    RUT_lexemes.json
    GEN_lexemes.json
    ...
  e/eng/eng_BSB/          # GIT-IGNORED — bulk data, published out-of-band (HF / object storage)
    RUT_101a1.json
    ...
  a/arb/arb_vdv/
    ...

Provenance

manifest.json lists every published (iso, edition) with its tag (the internal alignment id), books (which ones are published), and a source pointer (provider/edition/license_url) — same convention as lexeme-alignments. Alignment source is the additive union of eflomal + gloss + gapfill per-verse output (align_files.tag_files, exact-tag matched).

Reproducibility

Same content-addressed model as lexeme-alignments: eflomal is non-deterministic (seeds from /dev/urandom), so a regenerated edition's spans can drift ~1% run-to-run. There's no single dataset-wide hash to pin against here — the book-content hash in each filename pins the source text, not the alignment output; two regenerations of the same edition can legitimately publish under the same filename with slightly different span content.

Publishing (one-time per edition)

python3 -c "from huggingface_hub import login; login()"
python3 -m lexeme_aligner.compact_align --iso bsb --publish-iso eng --usj-dir data/usj-eng \
    --publish compact-alignments

License

CC0-1.0. As noted above, no Bible text is stored anywhere in this dataset — only integer token positions and spine verse references. There is nothing here that reproduces a source translation's copyrightable expression. The edition's own text (needed to decode a compact string into words) keeps its own license — see lexeme-alignments/manifest.json's sources pointers, or this dataset's own manifest.json, for the authoritative terms per edition.