classical-ja-pretrain / code /scripts /README_kanripo_clean.md
kuramot6f's picture
Initial release (history squashed)
7a088d4
|
Raw History Blame Contribute Delete
5.36 kB

Kanripo の学習用本文生成

ユーザー指定により、目録の時代分類が 清(異表記 淸 を含む)の資料を一律で除外し、Kanripo の管理記法を本文から除きます。原文は変更しません。

入力・除外

  • kanripo/metadata/manifest.csv の status=complete かつ非清の資料を入口にします。本文中・書名中の「清」の文字では除外しません。
  • 本文ファイルは KR_ID_数字.txt と、確認済みの接尾字を持つ KR_ID_数字a.txt 等です。Readme.org、*_ext.txt、画像一覧、取得管理JSON等は本文にしません。
  • 清分類、取得未完了、本文ファイルなしを excluded.jsonl に理由付きで記録します。理由は重複し得ます。
  • 時代不明は不明のまま残します。清分類の除外は、非清資料に含まれるすべての序跋・注釈・後代の編集について年代を保証するものではありません。

除去規則

  • Emacsモード行、#+TITLE・#+DATE・#+PROPERTY 等の管理行。
  • # src:、# dating: 等の英字で始まる編集コメント行。
  • <pb:…>・<md:…>・<PB …> の位置標識、、<折 t="…"/>、<img:…>。
  • #+BEGIN_VERSE・#+END_VERSE 等のブロック記法。中の文章は残します。
  • Org見出しの先頭の *、見出しを囲む #。見出しの文字は残します。# i#<哀時命> は <哀時命> を残します。
  • 型付きリンク [[date:…][八年]] 等は表示文字だけにします。空の表示文字は空になります。
  • 確認した旧ページコメント % BR0.1.1a と、ページ標識行の先頭に残る %。
  • 先頭BOM。

古い注釈、丸括弧、括弧内の /、欠字、外字記述、異体字、字下げ、改行、空行、句読点は保持します。たとえば外字記述の [[叠-且+互]] はリンクと誤認して削除しません。簡繁変換・NFKC・推測訂正はしません。

既知の管理タグや型付きリンクが壊れて残るファイルは review.jsonl に保留し、documents.jsonl には含めません。未知の本文記法を包括的に解釈する処理ではありません。

出力と利用

最新出力先は kanripo/preprocessed-v1/build-002/。documents.jsonl は 1行1本文ファイルで、学習に使うのは text フィールドです。original_header は来歴用であり、学習本文ではありません。巻の番号は保存しますが、作品単位の結合はしません。

ファイル 内容
documents.jsonl 採用本文、作品ID、目録分類、原文参照・原文ハッシュ、本文ハッシュ、原ヘッダ
excluded.jsonl 除外作品と理由
files.jsonl 全入力本文ファイルの採用・空・要確認状態、変換前後文字数・ハッシュ・規則別適用数
edits.jsonl 変更ファイルの監査情報
review.jsonl 管理記法が残存した要確認ファイル
duplicates.jsonl 清掃後の完全一致群。記録のみで自動削除しない
preview.jsonl 規則ごとの適用ファイルの先頭2,500文字の例。該当記法の位置そのものとは限らない
manifest.json 規則、入力一覧・取得目録・実装のハッシュ、完了状態
report.json ファイル数・文字数・規則別適用回数・時代別文字数
verification.json 出力全件の原文との照合結果

tokenize・packing・訓練・作品単位分割・他コーパスとの結合は行いません。

build-002 の集計

  • 清分類: 目録1,113作品を除外。このうち取得完了は1,096作品、取得未完了は17作品です。
  • その他の取得未完了と、取得完了だが本文ファイルのない9作品も不採用です。除外一覧は合計1,911作品です。
  • 全入力79,834本文ファイルを処理し、8,236作品の79,505本文ファイル、727,889,945文字を採用。
  • 管理行除去後の空ファイル329件。管理記法残存による保留は0件。
  • 清掃後の完全一致は13組。重複本文は削除していません。
  • 規則別の適用数は report.json、全件照合結果は verification.json を参照してください。
  • 9テスト合格。全79,834入力の原文ハッシュと、全79,505採用本文のシリアライズ後の全文・来歴・件数・清除外・管理記号の残存なしを検証済みです。

再現

新しい出力ディレクトリを指定します。既存結果は上書きしません。

python3 -m unittest discover -s scripts -p 'test_kanripo_clean.py' -v
python3 scripts/kanripo_profile.py --output kanripo/preprocessed-v1/inspection-next
python3 scripts/kanripo_clean.py --audit kanripo/preprocessed-v1/inspection-next --output kanripo/preprocessed-v1/build-next
python3 scripts/kanripo_verify_clean.py kanripo/preprocessed-v1/build-next

inspection-002 が最新の入力一覧です。旧 inspection-001 は KR5c0312_000a.txt を含みません。build-001 は改行をまたぐ日付リンク1ファイルを保留した旧版で、build-002 はその表示文字を保持して記法を除去する規則を追加した版です。