Clean and fix docs

style_bert_vits2/models/utils/__init__.py

@@ -215,13 +215,13 @@ def get_logger(
 
 def get_steps(model_path: Union[str, Path]) -> Optional[int]:
     """
-    モデルのパスからイテレーション番号を取得する
+    モデルのパスからイテレーション回数を取得する
 
     Args:
         model_path (Union[str, Path]): モデルのパス
 
     Returns:
-        Optional[int]: イテレーション番号
+        Optional[int]: イテレーション回数
     """
 
     matches = re.findall(r"\d+", model_path)  # type: ignore

style_bert_vits2/models/utils/checkpoints.py

@@ -27,7 +27,7 @@ def load_checkpoint(
         for_infer (bool): 推論用に読み込むかどうかのフラグ
 
     Returns:
-        tuple[torch.nn.Module, Optional[torch.optim.Optimizer], float, int]: 更新されたモデルとオプティマイザー、学習率、イテレーション番号
+        tuple[torch.nn.Module, Optional[torch.optim.Optimizer], float, int]: 更新されたモデルとオプティマイザー、学習率、イテレーション回数
     """
 
     assert os.path.isfile(checkpoint_path)
@@ -104,7 +104,7 @@ def save_checkpoint(
         model (torch.nn.Module): 保存するモデル
         optimizer (Union[torch.optim.Optimizer, torch.optim.AdamW]): 保存するオプティマイザー
         learning_rate (float): 学習率
-        iteration (int): イテレーション数
+        iteration (int): イテレーション回数
         checkpoint_path (Union[str, Path]): 保存先のパス
     """
     logger.info(

style_bert_vits2/models/utils/safetensors.py

@@ -22,7 +22,7 @@ def load_safetensors(
         for_infer (bool): 推論用に読み込むかどうかのフラグ
 
     Returns:
-        tuple[torch.nn.Module, Optional[int]]: 読み込まれたモデルとイテレーション番号（存在する場合）
+        tuple[torch.nn.Module, Optional[int]]: 読み込まれたモデルとイテレーション回数（存在する場合）
     """
 
     tensors: dict[str, Any] = {}
@@ -64,7 +64,7 @@ def save_safetensors(
 
     Args:
         model (torch.nn.Module): 保存するモデル
-        iteration (int): イテレーション番号
+        iteration (int): イテレーション回数
         checkpoint_path (Union[str, Path]): 保存先のパス
         is_half (bool): モデルを半精度で保存するかどうかのフラグ
         for_infer (bool): 推論用に保存するかどうかのフラグ

style_bert_vits2/tts_model.py

@@ -28,6 +28,7 @@ from style_bert_vits2.models.models import SynthesizerTrn
 from style_bert_vits2.models.models_jp_extra import (
     SynthesizerTrn as SynthesizerTrnJPExtra,
 )
+
 from style_bert_vits2.logging import logger
 from style_bert_vits2.voice import adjust_voice
 
@@ -39,11 +40,7 @@ class TTSModel:
     """
 
     def __init__(
-        self,
-        model_path: Path,
-        config_path: Path,
-        style_vec_path: Path,
-        device: str,
+        self, model_path: Path, config_path: Path, style_vec_path: Path, device: str
     ) -> None:
         """
         Style-Bert-Vits2 の音声合成モデルを初期化する。
@@ -170,10 +167,10 @@ class TTSModel:
             language (Languages, optional): 言語. Defaults to Languages.JP.
             speaker_id (int, optional): 話者 ID. Defaults to 0.
             reference_audio_path (Optional[str], optional): 音声スタイルの参照元の音声ファイルのパス. Defaults to None.
-            sdp_ratio (float, optional): SDP レシオ (値を大きくするとより感情豊かになる傾向がある). Defaults to DEFAULT_SDP_RATIO.
-            noise (float, optional): ノイズの大きさ. Defaults to DEFAULT_NOISE.
-            noise_w (float, optional): ノイズの大きさの重み. Defaults to DEFAULT_NOISEW.
-            length (float, optional): 長さ. Defaults to DEFAULT_LENGTH.
+            sdp_ratio (float, optional): DP と SDP の混合比。0 で DP のみ、1で SDP のみを使用 (値を大きくするとテンポに緩急がつく). Defaults to DEFAULT_SDP_RATIO.
+            noise (float, optional): DP に与えられるノイズ. Defaults to DEFAULT_NOISE.
+            noise_w (float, optional): SDP に与えられるノイズ. Defaults to DEFAULT_NOISEW.
+            length (float, optional): 生成音声の長さ（話速）のパラメータ。大きいほど生成音声が長くゆっくり、小さいほど短く早くなる。 Defaults to DEFAULT_LENGTH.
             line_split (bool, optional): テキストを改行ごとに分割して生成するかどうか. Defaults to DEFAULT_LINE_SPLIT.
             split_interval (float, optional): 改行ごとに分割する場合の無音 (秒). Defaults to DEFAULT_SPLIT_INTERVAL.
             assist_text (Optional[str], optional): 感情表現の参照元の補助テキスト. Defaults to None.

style_bert_vits2/voice.py

@@ -19,7 +19,7 @@ def adjust_voice(
         fs (int): 音声のサンプリング周波数
         wave (NDArray[Any]): 音声データ
         pitch_scale (float, optional): ピッチの高さ. Defaults to 1.0.
-        intonation_scale (float, optional): イントネーションの高さ. Defaults to 1.0.
+        intonation_scale (float, optional): イントネーションの平均からの変更比率. Defaults to 1.0.
 
     Returns:
         tuple[int, NDArray[Any]]: 調整後の音声データのサンプリング周波数と音声データ