diff --git a/README.md b/README.md index d6356b9..2a4cbd0 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ - **ニューラルかな漢字変換**: GPT-2ベースのモデルをllama.cppで推論し、高度な日本語変換 - **コンテキスト対応**: 周辺テキストを考慮した日本語変換 - **変換学習**: ユーザーが選択した変換結果を記憶し、次回以降の変換で優先表示。予測変換（前方一致）にも対応し、入力途中でも学習済みの候補を提示 -- **Sudachi辞書対応**: [SudachiDict](https://github.com/WorksApplications/SudachiDict)の辞書データからシステム辞書を構築可能 +- **システム辞書**: [SudachiDict](https://github.com/WorksApplications/SudachiDict)の辞書データからシステム辞書を構築 > **Note:** 初回起動時にHugging Faceからモデルをダウンロードするため、初回の変換開始までに時間がかかります。2回目以降はダウンロード済みのモデルが使用されます。 diff --git a/karukan-cli/README.md b/karukan-cli/README.md index bcce904..a64d93e 100644 --- a/karukan-cli/README.md +++ b/karukan-cli/README.md @@ -83,7 +83,7 @@ cargo run --release --bin karukan-dict -- view dict.bin --all Sudachi辞書CSVファイルからJSON辞書を生成します。デフォルトではSudachiの正規コストをそのまま使用し、`--model-scores` を指定するとjinenモデルのNLLスコアリングで候補を順序付けします。 -入力となるSudachi辞書CSVは[SudachiDict](https://d2ej7fkh96fzlu.cloudfront.net/sudachidict/)からダウンロードできます。 +入力となるSudachi辞書CSVは[SudachiDict](http://sudachi.s3-website-ap-northeast-1.amazonaws.com/sudachidict-raw/)からダウンロードできます。 ```bash # 基本的な使い方（Sudachiコストを使用） diff --git a/karukan-cli/docs/LEGAL b/karukan-cli/docs/LEGAL new file mode 100644 index 0000000..a406b9d --- /dev/null +++ b/karukan-cli/docs/LEGAL @@ -0,0 +1,129 @@ +LEGAL NOTICE INFORMATION +======================== + +- All the files in this distribution are covered under the Apache License +version 2.0. (see the file LICENSE-2.0.txt) + + +- src/main/text/small_lex.csv contains a part + of UniDic (https://unidic.ninjal.ac.jp/). +- src/main/text/matrix.def.zip is a part of UniDic. + +Copyright (c) 2011-2013, The UniDic Consortium +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the + distribution. + + * Neither the name of the UniDic Consortium nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +- src/main/text/core_lex.csv and src/main/text/notcore_lex.csv contain +a part of NEologd (https://github.com/neologd/mecab-unidic-neologd). + +Copyright (C) 2015-2019 Toshinori Sato (@overlast) + + https://github.com/neologd/mecab-unidic-neologd + + i. 本データは、株式会社はてなが提供するはてなキーワード一覧ファイル + 中の表記、及び、読み仮名の大半を使用している。 + + はてなキーワード一覧ファイルの著作権は、株式会社はてなにある。 + + はてなキーワード一覧ファイルの使用条件に基づき、また、 + データ使用の許可を頂いたことに対する感謝の意を込めて、 + 以下に株式会社はてなおよびはてなキーワードへの参照をURLで示す。 + + 株式会社はてな : http://hatenacorp.jp/information/outline + + はてなキーワード : + http://developer.hatena.ne.jp/ja/documents/keyword/misc/catalog + + ii. 本データは、日本郵便株式会社が提供する郵便番号データ中の表記、 + 及び、読み仮名を使用している。 + + 日本郵便株式会社は、郵便番号データに限っては著作権を主張しないと + 述べている。 + + 日本郵便株式会社の郵便番号データに対する感謝の意を込めて、 + 以下に日本郵便株式会社および郵便番号データへの参照をURLで示す。 + + 日本郵便株式会社 : + http://www.post.japanpost.jp/about/profile.html + + 郵便番号データ : + http://www.post.japanpost.jp/zipcode/dl/readme.html + + iii. 本データは、スナフキん氏が提供する日本全国駅名一覧中の表記、及び + 読み仮名を使用している。 + + 日本全国駅名一覧の著作権は、スナフキん氏にある。 + + スナフキん氏は 「このデータを利用されるのは自由ですが、その際に + 不利益を被ったりした場合でも、スナフキんは一切責任は負えません + ことをご承知おき下さい」と述べている。 + + スナフキん氏に対する感謝の意を込めて、 + 以下に日本全国駅名一覧のコーナーへの参照をURLで示す。 + + 日本全国駅名一覧のコーナー : + http://www5a.biglobe.ne.jp/~harako/data/station.htm + + iv. 本データは、工藤拓氏が提供する人名(姓/名)エントリデータ中の、 + 漢字表記の姓・名とそれに対応する読み仮名を使用している。 + + 人名(姓/名)エントリデータは被災者・安否不明者の人名の + 表記揺れ対策として、Mozcの人名辞書を活用できるという + 工藤氏の考えによって提供されている。 + + 工藤氏に対する感謝の意を込めて、 + 以下にデータ本体と経緯が分かる情報への参照をURLで示す。 + + 人名(姓/名)エントリデータ : + http://chasen.org/~taku/software/misc/personal_name.zip + + 上記データが提供されることになった経緯 + http://togetter.com/li/111529 + + v. 本データは、Web上からクロールした大量の文書データから抽出した + 表記とそれに対応する読み仮名のデータを含んでいる。 + + 抽出した表記とそれに対応する読み仮名の組は、上記の i. から iv. + の言語資源の組み合わせによって得られる組のみを採録した。 + + Web 上に文書データを公開して下さっている皆様に感謝いたします。 + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/karukan-cli/docs/LICENSE-2.0.txt b/karukan-cli/docs/LICENSE-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/karukan-cli/docs/LICENSE-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/karukan-cli/docs/NOTICE b/karukan-cli/docs/NOTICE new file mode 100644 index 0000000..09cda5f --- /dev/null +++ b/karukan-cli/docs/NOTICE @@ -0,0 +1,14 @@ +# Notice + +システム辞書 (`dict.bin`) は、株式会社ワークスアプリケーションズの +SudachiDict を元に構築されました。 + + + +元の CSV 辞書データに対して、日本語入力システム向けに一部の単語の削除や +前処理を行い、バイナリ形式に変換しています。 + +本辞書バイナリは SudachiDict と同じ Apache License, Version 2.0 の下で +配布しています。詳細は [LICENSE-2.0.txt](./LICENSE-2.0.txt) をご覧ください。 + +[LEGAL](./LEGAL) は SudachiDict リポジトリからコピーしたものです。 diff --git a/karukan-im/README.md b/karukan-im/README.md index c83cd5f..beadc93 100644 --- a/karukan-im/README.md +++ b/karukan-im/README.md @@ -204,7 +204,10 @@ yada double-array trieベースのシステム辞書で、モデル推論に加 ビルド済みの辞書を以下からダウンロードして配置できます: ```bash -curl -L https://github.com/togatoga/karukan/releases/download/v0.1.0/dict.bin.tgz | tar xz -C ~/.local/share/karukan-im/ +wget https://github.com/togatoga/karukan/releases/download/v0.1.0/dict.tgz +tar xzf dict.tgz +mkdir -p ~/.local/share/karukan-im +cp dict.bin ~/.local/share/karukan-im/ ``` 自分でビルドする場合は [karukan-cli の README](../karukan-cli/README.md) を参照してください。