Skip to content

Commit 9b050da

Browse files
committed
README: document the optional phonological layer (secryst crystals + interscript-ml index)
1 parent 6b76dc6 commit 9b050da

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,17 @@ image:https://github.com/interscript/interscript-ruby/actions/workflows/rake.yml
22
# Interscript
33

44
Documentation is available directory higher in file README.adoc.
5+
6+
## Phonological layer (optional)
7+
8+
Some transliteration systems need their input vocalized before the map
9+
can apply (undiacritized Arabic, nikud-less Hebrew, unsegmented Thai).
10+
The stdlib ships adapters for this: the `secryst` function dispatches
11+
to a [secryst crystal](https://www.secryst.org)
12+
`gem 'secryst'` (Ruby), `pip install secryst`, or `npm i secryst`
13+
which resolves a model id through the
14+
[interscript-ml `models.yaml` index](https://github.com/interscript/interscript-ml)
15+
and runs sha256-verified ONNX inference locally. The gem has no
16+
interscript dependency: a crystal can be used standalone for any G2P
17+
need, and an engine without a crystal simply cannot execute maps that
18+
declare a vocalization step.

0 commit comments

Comments
 (0)