From 52144affe2a379bebc3c7791333cad700c1fe10c Mon Sep 17 00:00:00 2001 From: ensan-hcl Date: Sat, 21 Sep 2024 13:30:42 +0900 Subject: [PATCH] docs: add zenzai --- Docs/zenzai.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/Docs/zenzai.md b/Docs/zenzai.md index c363deb..4bf88a4 100644 --- a/Docs/zenzai.md +++ b/Docs/zenzai.md @@ -1,30 +1,34 @@ # Zenzai -Zenzaiはニューラルかな漢字変換エンジンであり、高精度な変換を提供できるモードです。利用するには変換オプションの`zenzaiMode`を設定します。 +ニューラルかな漢字変換エンジン「Zenzai」を有効化することで、高精度な変換を提供できます。利用するには変換オプションの`zenzaiMode`を設定します。 ```swift let options = ConvertRequestOptions.withDefaultDictionary( // ... - zenzaiMode: .on(weight: url, inferenceLimit: 1) + zenzaiMode: .on( + weight: url, + inferenceLimit: 1, + versionDependentMode: .v2(.init(profile: "三輪/azooKeyの開発者", leftSideContext: "私の名前は")) + ) // ... ) ``` -* `weight`には`gguf`形式の重みファイルを指定します。重みファイルは[Hugging Face](https://huggingface.co/Miwa-Keita/zenz-v1)からダウンロードできます。 -* `inferenceLimit`には推論回数の上限を指定します。通常`1`で十分ですが、低速でも良い変換を得たい場合は`10`程度の値にすることもできます。 +* `weight`には`gguf`形式の重みファイルを指定します。重みファイルは[Hugging Face](https://huggingface.co/Miwa-Keita/zenz-v2-gguf)からダウンロードできます。 +* `inferenceLimit`には推論回数の上限を指定します。通常`1`で十分ですが、低速でも高精度な変換を得たい場合は`10`程度の値にすることもできます。 ## 動作環境 -* M1以上のスペックのあるmacOS環境が望ましいです +* M1以上のスペックのあるmacOS環境が望ましいです。GPUを利用します。 * モデルサイズに依存しますが、現状150MB程度のメモリを必要とします -* Linux環境でも動作しますが、CUDAが使えない可能性があります +* Linux環境・Windows環境でもCUDAを用いて動作します。 ## 仕組み - [Zennのブログ](https://zenn.dev/azookey/articles/ea15bacf81521e)をお読みいただくのが最もわかりやすい解説です。 ## 制約 -現状、Zenzaiを用いた場合学習機能は無効化されます。また、予測変換にはニューラル言語モデルは用いられていません。 +現状、Zenzaiを用いた場合ユーザ辞書が使えません。また、予測変換にはニューラル言語モデルは用いられていません。 ## 用語 * Zenzai: ニューラルかな漢字変換システム -* zenz-v1: Zenzaiで用いることのできるかな漢字変換モデル「zenz」の第1世代 \ No newline at end of file +* zenz-v1: Zenzaiで用いることのできるかな漢字変換モデル「zenz」の第1世代。`\uEE00\uEE01`というフォーマットでかな漢字変換タスクを行う機能に特化。 +* zenz-v2: Zenzaiで用いることのできるかな漢字変換モデル「zenz」の第2世代。第1世代の機能に加えて`\uEE00\uEE02\uEE01`というフォーマットで、左文脈を読み込む機能を追加。