整理: フルコンテキストラベル関連コメント/docstring/型ヒント

[tarepan]

内容

概要: フルコンテキストラベル関連のコメント/docstring/型ヒントをリファクタリング

full_context_label.py は OpenJTalk / フルコンテキストラベル（以下 label）を扱うモジュールである。
ここで定義されるクラス（例: BreathGroup, Utterance）は label 仕様を解釈する複雑な操作をおこなっている。
その複雑さに比べるとコメント量が少なく、仕様と実装の関係をコメントで明示すれば可読性向上が期待できる。

このような背景から、full_context_label.py へのコメント追加によるリファクタリングを提案します。

また同時に以下のリファクタリングを提案します：

• コーディング規約④ (コーディング規約集 #799) に基づく docstring の単純化
• deprecated な型ヒントのアップデート

関連 Issue

無し

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	487	333
voicevox_engine/init.py	1	0
voicevox_engine/cancellable_engine.py	91	71
voicevox_engine/core_wrapper.py	208	150
voicevox_engine/dev/core/init.py	2	0
voicevox_engine/dev/core/mock.py	27	12
voicevox_engine/dev/synthesis_engine/init.py	2	0
voicevox_engine/dev/synthesis_engine/mock.py	38	2
voicevox_engine/engine_manifest/EngineManifest.py	34	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	12	0
voicevox_engine/engine_manifest/init.py	3	0
voicevox_engine/library_manager.py	93	5
voicevox_engine/metas/Metas.py	33	0
voicevox_engine/metas/MetasStore.py	18	8
voicevox_engine/metas/init.py	2	0
voicevox_engine/model.py	162	9
voicevox_engine/morphing.py	70	46
voicevox_engine/part_of_speech_data.py	5	0
voicevox_engine/preset/Preset.py	12	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	81	2
voicevox_engine/preset/init.py	4	0
voicevox_engine/setting/Setting.py	11	0
voicevox_engine/setting/SettingLoader.py	18	0
voicevox_engine/setting/init.py	3	0
voicevox_engine/tts_pipeline/init.py	5	0
voicevox_engine/tts_pipeline/acoustic_feature_extractor.py	25	1
voicevox_engine/tts_pipeline/full_context_label.py	165	3
voicevox_engine/tts_pipeline/kana_parser.py	86	1
voicevox_engine/tts_pipeline/make_tts_engines.py	59	30
voicevox_engine/tts_pipeline/mora_list.py	4	0
voicevox_engine/tts_pipeline/tts_engine.py	185	13
voicevox_engine/tts_pipeline/tts_engine_base.py	71	10
voicevox_engine/user_dict.py	144	12
voicevox_engine/utility/init.py	5	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	10	0
voicevox_engine/utility/path_utility.py	26	8
TOTAL	2249	717

[Hiroshiba]

LGTM！！！

コメント付けありがとうございます！！
いくつか違和感あったのでこちらで変更してみました。
commitごとに何をどう変えたのかわかるようにしているので、参考になれば幸いです。

---

ついでに、よい機会だったので名称の起源を探っていました！
PhoenemeクラスをLabelクラスに、.labelを.featureにすると良いのかなぁとか思いました。

• フルコンテキストラベル
  • HTSの概念っぽい
  • 係り受けはfull-context label
  • 「コンテキスト」はただの「文脈」という単語として使っていて、ドメイン用語ではない
  • 「ラベル」は音素１つの情報を指すことも、文中の全情報を指すこともありそう
• ラベル
  • OpenJTalkの概念っぽい
  • JPCommonLabel
  • ラベル内のデータを文字列にしたものをfeatureと呼んでる
• p1とかa2とか
  • フルコンテキストラベル・ラベル内に含まれてる
  • これらを指した名称が見当たらない。。。

ということで、full_context_label.py内では、今のPhonemeクラスをLabelクラス（あるいはPhonemeLabelクラス）

[tarepan]

commitごとに何をどう変えたのかわかるようにしているので、参考になれば

非常にわかりやすかったです、丁寧にありがとうございました！

フルコンテキストラベル ... HTSの概念っぽい ...「コンテキスト」はただの「文脈」という単語として使っていて、ドメイン用語ではない

HTSに由来してたんですね、知らなかったです。
ドメイン用語/固有名詞じゃなくて「ラベルのうち、文脈モリモリのやつ」くらいの呼び名でしたか、なるほど…

PhoenemeクラスをLabelクラスに、.labelを.featureに
...
full_context_label.py内では、今のPhonemeクラスをLabelクラス（あるいはPhonemeLabelクラス）

👍
「ラベルの中に音素情報が含まれている」という構造を正しく反映したクラス名に感じます。
full_context_label.py 関連の別 issue を立てているので、そちらの一部として取り入れらればと思います。