⚠️ Early version / 初期バージョン This is an early baseline checkpoint (v2). Large-scale improvements to the architecture, training data, and accuracy are planned. これは初期のベースライン（v2）です。アーキテクチャ・学習データ・精度の 大規模な改善を今後予定しています。

English

Model overview

shiin-ime-gru is the on-device conversion model behind Shiin IME — an iOS custom keyboard that lets users type Japanese using consonants only, with no vowels. The model maps a consonant string to its reading.

Example: wtsh → watashi (わたし) / tbt → 食べた / gks → 学生

Architecture

Item	Value
Type	Transformer Encoder + GRU Decoder (attention-based seq2seq, character-level)
Parameters	~1.3M (hidden=256, embed=64, heads=4)
Input → Output	consonant sequence → reading (romaji / kana)
Checkpoint	`model_best.pt` (PyTorch, ~12 MB)
On-device	converted to CoreML (encoder + decoder, ~7 MB total)

Training data

Trained on a mixture of Japanese corpora — Wikipedia, CC-100, and the livedoor news corpus — for ~1B samples over 10 epochs.

Performance

Version	Best CER	Notes
v2 (this checkpoint)	0.2160	epoch 3/10, lr=1e-3 — early baseline

CER (Character Error Rate) is reported on the validation split. As an early version, accuracy is expected to improve substantially in future releases.

Intended use & limitations

Intended use: consonant-only Japanese text input (IME candidate generation), on-device inference on iOS via CoreML.
Limitations: early baseline; ambiguous consonant strings may produce incorrect readings. Not intended for general-purpose Japanese NLP.

Roadmap

Planned improvements include a larger / revised model architecture, expanded and cleaner training data, and substantially lower CER. Interface-changing updates may require training from scratch rather than fine-tuning this checkpoint.

Project

Source code (training + iOS keyboard): see the project repository.
License: MIT.

日本語

モデル概要

shiin-ime-gru は、Shiin IME（子音のみIME） のオンデバイス変換モデルです。 Shiin IME は、母音を入力せず 子音のみ で日本語を入力できる iOS 用カスタムキーボードです。本モデルは子音列をその読みへ変換します。

例: wtsh → watashi（わたし）/ tbt → 食べた / gks → 学生

アーキテクチャ

項目	内容
種別	Transformer Encoder + GRU Decoder（attention付き seq2seq・文字レベル）
パラメータ	約1.3M（hidden=256, embed=64, heads=4）
入出力	子音列 → 読み（ローマ字 / かな）
チェックポイント	`model_best.pt`（PyTorch, 約12MB）
オンデバイス	CoreML へ変換（encoder + decoder, 合計約7MB）

学習データ

日本語コーパス（Wikipedia・CC-100・livedoorニュースコーパス）の混合データを用い、約10億サンプル・10エポックで学習しています。

性能

バージョン	Best CER	備考
v2（本チェックポイント）	0.2160	epoch 3/10, lr=1e-3 — 初期ベースライン

CER（文字誤り率）は検証データでの値です。初期バージョンのため、今後のリリースで精度は大幅に向上する見込みです。

想定用途と制約

想定用途: 子音のみの日本語入力（IME候補生成）、iOS上での CoreML オンデバイス推論。
制約: 初期ベースラインです。曖昧な子音列では誤った読みを出力することがあります。汎用の日本語NLP用途は想定していません。

ロードマップ

今後、モデルの大型化・アーキテクチャ刷新、学習データの拡充とクリーニング、 CERの大幅な低減を予定しています。入出力インターフェースを変更する更新では、本チェックポイントからの継続学習ではなくスクラッチからの再学習が必要になる場合があります。

プロジェクト

ソースコード（学習コード + iOSキーボード）: プロジェクトリポジトリを参照。
ライセンス: MIT。

YUGOROU/shiin-ime-gru

Shiin IME — Consonant-only Japanese IME model / 子音のみ日本語IMEモデル