Skip to content

README: document the optional phonological layer (secryst) #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ronaldtse merged 1 commit into from
Aug 20, 2026
Merged

README: document the optional phonological layer (secryst) #761

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,17 @@ image:https://github.com/interscript/interscript-ruby/actions/workflows/rake.yml
# Interscript

Documentation is available directory higher in file README.adoc.

## Phonological layer (optional)

Some transliteration systems need their input vocalized before the map
can apply (undiacritized Arabic, nikud-less Hebrew, unsegmented Thai).
The stdlib ships adapters for this: the `secryst` function dispatches
to a [secryst crystal](https://www.secryst.org) —
`gem 'secryst'` (Ruby), `pip install secryst`, or `npm i secryst` —
which resolves a model id through the
[interscript-ml `models.yaml` index](https://github.com/interscript/interscript-ml)
and runs sha256-verified ONNX inference locally. The gem has no
interscript dependency: a crystal can be used standalone for any G2P
need, and an engine without a crystal simply cannot execute maps that
declare a vocalization step.
Loading