Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
suffix-thumb
Advanced tools
discover the minimal rules for mapping two sets of words to one another, according to changes in their suffix.
It was built for learning rules about verb conjugations, but in a way, it is just a generic compression algorithm.
The assumption is that a word's suffix is the most-often changed part of a word.
import { learn, convert } from 'suffix-thumb'
let pairs = [
['walk', 'walked'],
['talk', 'talked'],
['go', 'went'],
]
let model = learn(pairs)
/* {
rules: { k: [ [ 'alk', 'alked' ] ] },
exceptions: { go: 'went' },
}*/
let out = convert('walk', model)
// 'walked'
you can pass-in options:
let opts={
threshold:80, //how sloppy our initial rules can be
min:0, //rule must satisfy # of pairs
reverse:true, //compute backward transformation, too
}
let model = learn(pairs, opts)
the model also works transforming the words the other way:
import { learn, reverse, convert } from 'suffix-thumb'
let pairs = [
['walk', 'walked'],
['talk', 'talked'],
['go', 'went'],
]
let model = learn(pairs)
let rev = reverse(model)
let out = convert('walked', rev)
// 'walk'
by default, the model ensures all two-way transformation - if you only require 1-way, you can do:
learn(pairs, {reverse: false})
you can expect the model to be 5% smaller or so - not much.
by default, the model is small, but remains human-readable (and human-editable). We can compress it further, turning it into a snowball inscrutible characters:
import { learn, compress, uncompress, convert } from 'suffix-thumb'
let pairs = [
['walk', 'walked'],
['talk', 'talked'],
['go', 'went'],
]
let model = learn(pairs)
// shrink it
model = compress(shrink)
// {rules:'LSKs3H2-LNL.S3DH'}
// pop it back
model = uncompress(model)
let out = convert('walk', model)
// 'walked'
The models must be uncompressed before they are used, or reversed.
sometimes you can accidentally send in an impossible set of transformations. This library quietly ignores duplicates, by default.
You can use {verbose:true}
to log warnings about this, or validate your input manually:
import { validate } from 'suffix-thumb'
let pairs = [
['left', 'right'],
['left', 'right-two'],
['ok', 'right'],
]
pairs = validate(pairs) //remove dupes (on both sides)
If you are just doing one-way transformation, and not reverse, you may want to allow duplicates on the right side:
let pairs = [
['left', 'right'],
['ok', 'right'],
]
let model = learn(pairs, {reverse: false})
let out = convert('ok', model)
// 'right'
For each word-pair, it generates all n-suffixes of the left-side, and n-suffixes of the right-side.
any good correlations between the two suffix pairs begins to pop out. Exceptions to these rules are remembered. It then exhaustively reduces any redundancies in these rules.
There are some compromises, magic-numbers, and opinionated decisions - in-order to allow productive, but imperfect rules.
The library drops case-information - and numbers and some characters1 will not compress properly.
There may be wordlists with few helpful patterns. Conjugation datasets in English and French tend to get ~85% filesize compression.
MIT
5.0.2 [Feb 2023]
FAQs
learn transformations between two sets of words
The npm package suffix-thumb receives a total of 33,959 weekly downloads. As such, suffix-thumb popularity was classified as popular.
We found that suffix-thumb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new license scanner with an improved suite of features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.