Skip to content
BranchesTags

Repository files navigation

AzooKeyKanaKanjiConverter

AzooKeyKanaKanjiConverterはazooKeyのために開発したかな漢字変換エンジンです。数行のコードでかな漢字変換をiOS / macOS / visionOSのアプリケーションに組み込むことができます。

また、AzooKeyKanaKanjiConverterはニューラルかな漢字変換システム「Zenzai」を利用した高精度な変換もサポートしています。

動作環境

iOS 16以降, macOS 13以降, visionOS 1以降, Ubuntu 22.04以降で動作を確認しています。Swift 6.1以上が必要です。

AzooKeyKanaKanjiConverterの開発については開発ガイドをご覧ください。 学習データの保存先やリセット方法についてはDocs/learning_data.mdを参照してください。

KanaKanjiConverterModule

かな漢字変換を受け持つモジュールです。

セットアップ

  • Xcodeprojの場合、XcodeでAdd Packageしてください。

  • Swift Packageの場合、Package.swiftのPackageの引数にdependencies以下の記述を追加してください。

    dependencies: [
    .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", .upToNextMinor(from: "0.8.0"))
],

    また、ターゲットのdependenciesにも同様に追加してください。

    .target(
    name: "MyPackage",
    dependencies: [
        .product(name: "KanaKanjiConverterModuleWithDefaultDictionary", package: "AzooKeyKanaKanjiConverter")
    ],
),

Important

AzooKeyKanaKanjiConverterはバージョン1.0のリリースまで開発版として運用するため、マイナーバージョンの変更で破壊的変更を実施する可能性があります。バージョンを指定する際にはマイナーバージョンが上がらないよう、.upToNextMinor(from: "0.8.0")のように指定することを推奨します。

使い方

// デフォルト辞書つきの変換モジュールをインポート
import KanaKanjiConverterModuleWithDefaultDictionary

// 変換器を初期化する（デフォルト辞書を利用）
let converter = KanaKanjiConverter.withDefaultDictionary()
// 入力を初期化する
var c = ComposingText()
// 変換したい文章を追加する
c.insertAtCursorPosition("あずーきーはしんじだいのきーぼーどあぷりです", inputStyle: .direct)
// 変換のためのオプションを指定して、変換を要求
let results = converter.requestCandidates(c, options: .init(
    N_best: 10,
    requireJapanesePrediction: .autoMix,
    requireEnglishPrediction: .disabled,
    keyboardLanguage: .ja_JP,
    englishCandidateInRoman2KanaInput: true,
    fullWidthRomanCandidate: false,
    halfWidthKanaCandidate: false,
    learningType: .inputAndOutput,
    maxMemoryCount: 65536,
    shouldResetMemory: false,
    memoryDirectoryURL: FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!,
    sharedContainerURL: FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!,
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders,
    metadata: .init(versionString: "Your App Version X")
))
// 結果の一番目を表示
print(results.mainResults.first!.text)  // azooKeyは新時代のキーボードアプリです

ConvertRequestOptionsは変換リクエストに必要な情報を指定します。詳しくはコード内のドキュメントコメントを参照してください。

ConvertRequestOptions

ConvertRequestOptionsは変換リクエストに必要な設定値です。例えば以下のように設定します。

let documents = FileManager.default
    .urls(for: .documentDirectory, in: .userDomainMask)
    .first!
let options = ConvertRequestOptions(
    // 日本語予測変換
    requireJapanesePrediction: .autoMix,
    // 英語予測変換 
    requireEnglishPrediction: .disabled,
    // 入力言語 
    keyboardLanguage: .ja_JP,
    // 学習タイプ 
    learningType: .nothing, 
    // 学習データを保存するディレクトリのURL（書類フォルダを指定）
    memoryDirectoryURL: documents,
    // ユーザ辞書データのあるディレクトリのURL（書類フォルダを指定）
    sharedContainerURL: documents,
    // メタデータ
    metadata: .init(versionString: "Your App Version X"),
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders
)

開く際に保存処理が中断された .pause ファイルが残っている場合は、変換器が自動的に復旧を試みてファイルを削除します。

ComposingText

ComposingTextは入力管理を行いつつ変換をリクエストするためのAPIです。ローマ字入力などを適切にハンドルするために利用できます。詳しくはドキュメントを参照してください。

Zenzaiを使う

ニューラルかな漢字変換システム「Zenzai」を利用するには、追加でSwift Package Traitsの設定を行う必要があります。AzooKeyKanaKanjiConverterはGPU向けの「Zenzai」およびCPU専用の「ZenzaiCPU」というTraitをサポートしています。環境に応じていずれかを追加してください。

dependencies: [
    // GPU (Metal/CUDA 等) を使う場合
    .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", .upToNextMinor(from: "0.8.0"), traits: ["Zenzai"]),
    // CPU のみで動作させる場合（オフロード無効）
    // .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", .upToNextMinor(from: "0.8.0"), traits: ["ZenzaiCPU"]),
],

ConvertRequestOptionsのzenzaiModeを指定します。詳しい引数の情報についてはドキュメントを参照してください。

let options = ConvertRequestOptions(
    // ...
    requireJapanesePrediction: .autoMix,
    requireEnglishPrediction: .disabled,
    keyboardLanguage: .ja_JP,
    learningType: .nothing,
    memoryDirectoryURL: documents,
    sharedContainerURL: documents,
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders,
    zenzaiMode: .on(weight: url, inferenceLimit: 10),
    metadata: .init(versionString: "Your App Version X")
)

辞書データ

AzooKeyKanaKanjiConverterのデフォルト辞書としてazooKey_dictionary_storageがサブモジュールとして指定されています。過去のバージョンの辞書データはGoogle Driveからもダウンロードすることができます。

英字readingのエントリも利用できます。例えばreadingと表記がともに GitHub のエントリは、Git の前方一致や GitHub の完全一致で英語候補になります。辞書のreading・表記はそのまま保持し、検索時は入力中の小文字を対応する大文字にも一致させます。大文字の入力は大文字だけに一致します。例えば git は GitHub と github の両方に一致し、Git は github に一致しません。この規則は語中にも適用します。登録条件は、ASCII英数字・半角スペース・- ' ’ & . ! ? , : ; = だけで構成され、英字を1文字以上含むことです。記号・スペースの位置や連続回数は制限せず、大小文字を含めて元の表記を保持します。.NET、=LOVE、Yahoo!!、New York、R & D などに対応します。タブ・改行・全角文字・アクセント付き文字など、許可文字以外を含む表記は対象外です。検索キーは英字をまだ含まない .・=・半角スペースなども許可し、登録語を前方一致で補完します。数字・記号・スペースは完全一致で照合し、' と ’ は区別します。OSへの補完問い合わせは従来どおり英字だけの入力に限定します。

requireEnglishPrediction を有効にすると、辞書候補とOSの補完候補を統合します。.manualMix では englishPredictionResults に返し、.autoMix では通常の候補にも混ぜます。日本語ローマ字入力中の英語候補には englishCandidateInRoman2KanaInput を使います。辞書候補には登録スコアと既存の英語候補ペナルティを適用し、同じ表記の候補は重複除去します。

anco dict build の入力は従来の6列TSV（reading・表記・左品詞ID・右品詞ID・意味ID・スコア）です。取り込み対象の先頭文字はcharID表から自動生成し、明示的な除外文字のみ除きます。英字で始まる入力ファイルは、大小文字を区別しないファイルシステムでの衝突を避け、worddict/[0047].tsv（G）、worddict/[0067].tsv（g）のように先頭文字のコードを4桁の大文字16進数で表します。カタカナ等の既存ファイル名は変更しません。charIDの対応表には末尾に .（ID 227）、半角スペース（ID 228）、! ? , : ;（順にID 229〜233）を追加し、既存IDとバイナリ形式は維持します。= は既存IDを使用し、CLIの ! を含むreadingの除外も解除します。ピリオド・半角スペース・! ? , : ; を含むreadingを使うには、新しいビルド結果の charID.chid と辞書ファイルを一緒に配布してください。

また、以下のフォーマットであれば自前で用意した辞書データを利用することもできます。カスタム辞書データのサポートは限定的なので、ソースコードを確認の上ご利用ください。

- Dictionary/
  - louds/
    - charId.chid
    - X.louds
    - X.loudschars2
    - X.loudstxt3
    - ...
  - p/
    - X.csv
  - cb/
    - 0.binary
    - 1.binary
    - ...
  - mm.binary

デフォルト以外の辞書データを利用する場合、ターゲットのdependenciesに以下を追加してください。

.target(
  name: "MyPackage",
  dependencies: [
      .product(name: "KanaKanjiConverterModule", package: "AzooKeyKanaKanjiConverter")
  ],
),

利用時に、辞書データのディレクトリを明示的に指定する必要があります（オプションではなく、変換器の初期化時に指定します）。

// デフォルト辞書を含まない変換モジュールを指定
import KanaKanjiConverterModule

let documents = FileManager.default
    .urls(for: .documentDirectory, in: .userDomainMask)
    .first!
// カスタム辞書ディレクトリを指定して変換器を初期化
let dictionaryURL = Bundle.main.bundleURL.appending(path: "Dictionary", directoryHint: .isDirectory)
let converter = KanaKanjiConverter(dictionaryURL: dictionaryURL, preloadDictionary: true)

// 変換リクエスト時のオプションを用意
let options = ConvertRequestOptions(
    requireJapanesePrediction: .autoMix,
    requireEnglishPrediction: .disabled,
    keyboardLanguage: .ja_JP,
    learningType: .nothing,
    memoryDirectoryURL: documents,
    sharedContainerURL: documents,
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders,
    metadata: .init(versionString: "Your App Version X")
)

dictionaryResourceURL は ConvertRequestOptions から廃止されました。デフォルト辞書を使う場合は KanaKanjiConverterModuleWithDefaultDictionary を、カスタム辞書を使う場合は KanaKanjiConverterModule を利用し、変換器初期化時に辞書ディレクトリを指定してください。

SwiftUtils

Swift一般に利用できるユーティリティのモジュールです。

About

Kana-Kanji Conversion Module written in Swift, supporting Neural Kana-Kanji Conversion and other cool features.

azooKey.com

Topics

azookeyimeinput-methodiosjapanesekanakanjiconversionmacosnatural-language-processingnlpswift

Resources

Readme
MIT license
Activity
Custom properties

Stars

159 stars

Watchers

4 watching

Forks

41 forks
Report repository

Releases

Sponsor this project

Used by

Contributors

Languages