Skip to content

OPENNLP-1934: Evaluate the tokenizer alphanumeric pattern as a character set - #1281

Draft
krickert wants to merge 18 commits into
apache:mainfrom
ai-pipestream:OPENNLP-1934-tokenizer-alphanumeric
Draft

OPENNLP-1934: Evaluate the tokenizer alphanumeric pattern as a character set#1281
krickert wants to merge 18 commits into
apache:mainfrom
ai-pipestream:OPENNLP-1934-tokenizer-alphanumeric

Conversation

@krickert

@krickert krickert commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Based on #1275, and independent of the other parts of the epic. It can be reviewed and merged in any order relative to them. This diff carries the #1275 commits until that one merges; the commits of this change alone: ai-pipestream/opennlp@OPENNLP-1928-regex-removal-trivial...OPENNLP-1934-tokenizer-alphanumeric

The alphanumeric pattern stays a Pattern in TokenizerFactory and lang.Factory: it is written to the model manifest as a regex string and read back with Pattern.compile, so the type is part of the model contract and existing models carry one.

What changes is the hot path. A package-private AlphaNumericCheck reads a pattern of the shape ^[...]+$ whose class holds only plain characters and simple ranges, which covers each built-in language default, into a character set and tests tokens by lookup. Any other pattern, and any pattern compiled with flags, is still matched by the engine, so the result equals pattern.matcher(token).matches() in all cases. TokenizerME and TokSpanEventStream hold the check instead of the Pattern.

Verification: the test compares the check with the regex for all built-in defaults and a set of custom patterns over the same token table, and records which shapes run as a set lookup. opennlp-runtime: 3,624 tests with checkstyle, offline, -Dopennlp.forkCount=1.

OPENNLP-1934

…in DefaultPOSContextGenerator

Add pinning tests for the accept and reject sides of both predicates.
… checks in FeatureGeneratorUtil

Add pinning tests for the capPeriod accept and reject sides.
…enPatternFeatureGenerator

Add a pinning test that non-letter sub-tokens do not produce st= features.
… char scan

Matches (.+)-\w+ semantics: group(1) is everything before the last hyphen,
the hyphen must not be at index 0, and the suffix must be non-empty word
chars. Add pinning tests for outcomes without hyphen, hyphen at index 0,
empty suffix, non-word suffix, and the normal accept case.
…n BrownCluster

Replicates String.split(\t) semantics, including dropped trailing empty fields.
…explicit char scans in TokenSampleStream

splitOnWhitespace replicates String.split(\\s+): a leading whitespace run
yields one empty leading field, runs collapse, and trailing empty fields are
dropped.
…mojiCharSequenceNormalizer

The replaced pattern contains a high surrogate range, so the regex engine
matches whole code points in the flattened range [U+D83C, U+10FC00]. The
replacement scans code points, collapses each maximal matching run into a
single space, and copies non-matching code points verbatim. Add pinning
tests for unpaired surrogates, BMP chars above U+D83C, and supplementary
code points beyond U+10FC00.
…xplicit scans in ConlluStream

splitOnHyphen replicates String.split("-"): every hyphen is a boundary,
empty fields between consecutive hyphens are kept, and trailing empty
fields are dropped.

extractTextLang replicates find() of text_([a-z]{2,3}): the first
occurrence of "text_" followed by two to three ASCII lowercase letters,
preferring three.
…ss scans in ParserTool

The two replaceAll passes are replicated by two cursor passes with the
same leftmost-first resume-after-match semantics, which matters for
overlapping pairs such as "x((" or "((a)(b))": a pair starting at the
second char of a match is only reconsidered by the second pass.
…cans in DownloadUtil

parseChecksum now scans to the first ASCII whitespace character,
replicating split(\s)[0] on the trimmed content.

extractLinks replicates find() of the <a href="(.*?)">(.*?)</a> pattern
with CASE_INSENSITIVE and DOTALL flags: the href value ends at the first
"> and the first case-insensitive </a> closes the match, so nested link
markup is swallowed by the outer match.
…meric patterns with explicit scans in ADNameSampleStream

splitOnWhitespace and splitOnUnderscores replicate run-based splitting: a
leading separator run yields one empty leading field, trailing empty
fields are dropped, and an all-separator input yields no fields.

matchHyphenatedToken replicates the three-branch hyphen pattern at code
point granularity, isAlphaNumeric replicates ^[\p{L}\p{Nd}]+$ via
Character.isLetter and Character.isDigit, and tagContent replicates
matches() of <(NER:)?(.*?)> including its optional NER: prefix.
…OSSampleStream

replaceWhitespaceWithEquals replicates replaceAll("=") of the \s+
pattern: every run of ASCII whitespace, including leading and trailing
runs, is replaced by a single equals sign.
…tenceSampleStream

parseTextAndParagraph replicates matches() of the
^(?:[a-zA-Z\-]*(\d+)).*?p=(\d+).* pattern: after the optional ASCII
letters and hyphens, the text id is the first ASCII digit run and the
paragraph id is the digit run after the first "p=" that is followed by
at least one digit.
…entenceStream

replaceGuillemetPunctuation replicates replaceAll of the »\s+ punct
patterns: every run of ASCII whitespace between » and the punctuation
character is removed.

parsePunctuationLine replicates matches() of the ^(=*)(\W+)$ pattern:
the line consists of leading equals signs followed by one or more
non-word characters, where a word character is an ASCII letter, digit,
or underscore. A line of only equals signs matches, with the last
equals sign as lexeme.
Adds StringUtil.isAsciiWhitespace, splitOnAsciiWhitespace,
containsAsciiUpperCase, and containsAsciiDigit and removes the copies
from the AD streams, the English TokenSampleStream, DownloadUtil, and
the POS and lemmatizer context generators. NameFinderME.extractNameType
delegates to BioCodec.

Cases the new tests found first: the TokenSampleStream split returned
one empty token for a whitespace-only line where the original split
returned none, and matchHyphenatedToken accepted a single hyphen.
BrownCluster.splitTabs now removes all trailing empty fields, as
String.split does.

Each helper has a test, parameterized where the inputs are a table,
with the reject side and the edge cases: empty input, leading and
trailing separators, non-ASCII spaces and digits, and
supplementary-plane characters. Helpers only called from instance
methods are no longer static; the block comments on the helpers are
now Javadoc that states the behavior.
…ter set

The alphanumeric pattern is a tokenizer model parameter: TokenizerFactory
stores it in the manifest as a regex string and reads it back with
Pattern.compile, so the Pattern type stays in the API. Matching no longer
goes through the regex engine for the shipped defaults: AlphaNumericCheck
reads a pattern of the shape ^[...]+$ with literal characters and simple
ranges into a character set and tests tokens by lookup. Any other pattern,
and any pattern compiled with flags, is still matched by the engine, so
the result equals pattern.matcher(token).matches() in all cases.

TokenizerME and TokSpanEventStream hold the check instead of the Pattern.
The test compares the check with the regex for all built-in language
defaults and a set of custom patterns over the same tokens, and pins which
shapes run as a set lookup.
@krickert
krickert force-pushed the OPENNLP-1934-tokenizer-alphanumeric branch from 9a87410 to 1fc8ebe Compare September 7, 2026 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant