Skip to content

Commit 1480b05

Browse files
committed
docs: Usage with Secryst — current model contract (index-resolved IMF zips, three crystals, catalog link)
1 parent c15cb8d commit 1480b05

1 file changed

Lines changed: 38 additions & 19 deletions

File tree

docs/Usage_with_Secryst.adoc

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,57 @@
11
= Usage with Secryst
22

3-
Secryst is a seq2seq transformer suited for transliteration. Written in Ruby.
4-
It's installation is a bit tricky, you should consult its own installation guide
5-
(https://github.com/secryst/secryst[at GitHub]). By default we don't use Secryst,
6-
unless you have installed it.
3+
Secryst is the neural layer of Interscript: distilled, byte-level
4+
models for conversions that have no authority map — diacritization,
5+
grapheme-to-phoneme, homograph disambiguation. The models ship as
6+
checksummed IMF v1 artifacts resolved from the
7+
https://github.com/interscript/interscript-ml[interscript-ml] index;
8+
nothing is bundled in the library.
79

8-
== Using it standalone
9-
10-
It's enough to install it. Be sure to consult the guide above.
11-
12-
== Integration with Ruby Applications
13-
14-
In your Gemfile, add:
10+
== Install
1511

1612
[source,ruby]
1713
----
18-
source "https://rubygems.org"
14+
gem install secryst # Ruby
15+
----
1916

20-
gem "secryst"
17+
[source,sh]
2118
----
19+
pip install secryst # Python
20+
npm install secryst # TypeScript / JavaScript
21+
----
22+
23+
== Loading a model
2224

23-
Create a Secrystfile near your Gemfile with the following, for each model you
24-
want to use in your application. Please consult our Secrystfile to get all the
25-
maps needed to get all the Secryst maps needed.
25+
Models resolve by id against the public index, download once into a
26+
content-addressed cache, and verify every member checksum on load:
2627

2728
[source,ruby]
2829
----
29-
model "model-name"
30+
require "secryst"
31+
32+
model = Secryst::Model.load("tha-g2p-small-1.0")
33+
model.translate("สวัสดี")
34+
# => "sa˨˩.wat̚˨˩.diː˧"
3035
----
3136

37+
== Catalog
38+
39+
The catalogue of released models — with the measured metric next to
40+
each teacher's, per the published protocol — lives at
41+
https://interscript.org/ml[/ml] and in the
42+
https://github.com/interscript/interscript-ml/blob/main/docs/RESULTS.md[results log].
43+
44+
== Deployment overrides
45+
46+
Both overrides are read at call time in all three runtimes:
47+
48+
* `SECRYST_INDEX` — a models.yaml URL or path (mirror or pin)
49+
* `SECRYST_CACHE` — cache directory (default `~/.cache/secryst`)
50+
3251
== Usage inside maps
3352

53+
Neural conversion composes with deterministic stages:
54+
3455
[source,ruby]
3556
----
3657
stage {
@@ -39,5 +60,3 @@ stage {
3960
# ... sub "c", "d" ...
4061
}
4162
----
42-
43-
As of now, Secryst is usable only by the Ruby implementation.

0 commit comments

Comments
 (0)