Skip to content

Commit 4889987

Browse files
BonoJoviclaude
andcommitted
docs: tidy README for public release; correct LLM model to 1.5B
- Replace the SEO keyword-stuffed tagline with a clean one-liner. - Fix stale Qwen2.5-0.5B references to the actually-shipped default, Qwen2.5-1.5B (service file + install-llama-server.sh), in the README (features, components, requirements, model download URL/size) and the llm module doc comments. The remaining 0.5B mentions are deliberate 1.5B-vs-0.5B comparisons and stay. - Point the LLM setup section at scripts/install-llama-server.sh as the one-command path. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 92fb3ef commit 4889987

3 files changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div align="center">
44

5-
**Japanese Input Method / Japanese a Input Method / Japanese AI Method**
5+
**An LLM-powered Japanese input method for Linux — IBus & Fcitx5**
66

77
[![Version](https://img.shields.io/badge/Version-3.0.0-blue)](https://github.com/BonoJovi/Bonolith/releases)
88
[![Rust](https://img.shields.io/badge/Rust-2024-orange.svg)](https://www.rust-lang.org/)
@@ -21,7 +21,7 @@
2121
- **辞書変換** — IPADIC ベースの 232,000+ エントリ辞書(Trie 検索 + DP 分節)
2222
- **活用形対応** — 動詞・形容詞の活用形を自動生成(食べた、走って、読んだ 等)
2323
- **記号入力** — 矢印(やじるし→)、括弧ペア(かっこ→「」)等の記号辞書
24-
- **LLM リランキング** — Qwen2.5-0.5B + ローカル HTTP サーバーによる文脈を考慮した候補順位付け(バックグラウンド実行)
24+
- **LLM リランキング** — Qwen2.5-1.5B + ローカル HTTP サーバーによる文脈を考慮した候補順位付け(バックグラウンド実行)
2525
- **文法スコアリング** — 文法ルールによる候補フィルタリング
2626
- **ユーザ学習** — 選択履歴を学習し、候補順位を最適化
2727
- **文節編集** — 文節の移動・伸縮・候補切替
@@ -49,7 +49,7 @@
4949
| **ローマ字変換器** | ASCII → ひらがな / カタカナのステートマシン |
5050
| **辞書エンジン** | Trie ベースのかな→漢字検索 + DP 分節(232K エントリ) |
5151
| **文法エンジン** | 構造検証とスコアリング(9 ルール) |
52-
| **LLM エンジン** | llama-server (HTTP) 経由の Qwen2.5-0.5B によるバックグラウンドリランキング |
52+
| **LLM エンジン** | llama-server (HTTP) 経由の Qwen2.5-1.5B によるバックグラウンドリランキング |
5353
| **ユーザスコアラ** | 選択履歴の対数スケール学習 |
5454
| **変換エンジン** | パイプライン統合と文節編集 |
5555

@@ -103,7 +103,7 @@ Bonolith/
103103
- IPADIC 辞書(`sudo apt install mecab-ipadic`
104104
- 辞書登録 / 編集ダイアログ(GTK3): `sudo apt install python3-gi gir1.2-gtk-3.0 xdotool`
105105
- Wayland セッションでも `GDK_BACKEND=x11` で XWayland 経由で起動するため、xdotool が動作する Xorg / XWayland が必要
106-
- LLM 用(オプション): llama-server + Qwen2.5-0.5B Q4 モデル(約 512MB
106+
- LLM 用(オプション): llama-server + Qwen2.5-1.5B Q4 モデル(約 1.1GB
107107

108108
## ビルド
109109

@@ -124,6 +124,10 @@ cargo build --release
124124
LLM リランキングを有効にするには、llama-server をセットアップします。
125125
LLM サーバーが起動していなくても Bonolith は正常に動作します(辞書+文法+ユーザ学習のみで変換)。
126126

127+
> **かんたん導入**: 下記 1〜2 を自動化したスクリプトがあります。
128+
> `./scripts/install-llama-server.sh` で llama-server バイナリとモデル(Qwen2.5-1.5B)を取得します(`--no-model` でバイナリのみ)。
129+
> 手動でセットアップする場合は以下を参照してください。
130+
127131
### 1. llama-server のインストール
128132

129133
[llama.cpp リリースページ](https://github.com/ggml-org/llama.cpp/releases) から Ubuntu x64 バイナリをダウンロード:
@@ -146,7 +150,7 @@ cp llama-*/lib*.so* ~/.local/lib/
146150
```bash
147151
mkdir -p ~/.local/share/bonolith/models
148152
cd ~/.local/share/bonolith/models
149-
curl -LO https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct-GGUF/resolve/main/qwen2.5-0.5b-instruct-q4_k_m.gguf
153+
curl -LO https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct-GGUF/resolve/main/qwen2.5-1.5b-instruct-q4_k_m.gguf
150154
```
151155

152156
### 3. systemd サービスとして登録

src/core/llm/http_scorer.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/// and isolates the model in a separate process.
66
///
77
/// The server should be started separately (e.g., via systemd):
8-
/// llama-server -m ~/.local/share/bonolith/models/qwen2.5-0.5b-instruct-q4_k_m.gguf \
8+
/// llama-server -m ~/.local/share/bonolith/models/qwen2.5-1.5b-instruct-q4_k_m.gguf \
99
/// --host 127.0.0.1 --port 8080 --ctx-size 512
1010
1111
use std::sync::atomic::{AtomicBool, Ordering};
@@ -298,7 +298,7 @@ mod tests {
298298
if ok { "OK" } else { "MISS" }
299299
);
300300
}
301-
// The 0.5B model isn't perfect, but it should clear a clear majority.
301+
// The model isn't perfect, but it should clear a clear majority.
302302
assert!(correct >= 4, "only {correct}/5 homophone cases correct");
303303
}
304304
}

src/core/llm/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// LLM-based contextual ranking and final validation
22
///
3-
/// Uses a local quantized model (Qwen2.5-0.5B Q4_K_M) for:
3+
/// Uses a local quantized model (Qwen2.5-1.5B Q4_K_M) for:
44
/// 1. Disambiguating homophone candidates
55
/// 2. Final check on dictionary-converted sentences
66
/// 3. Context-aware reranking of candidates

0 commit comments

Comments
 (0)