cyacya8023 commited on
Commit
fbcb689
·
verified ·
1 Parent(s): e69fa2e

docs: focus agent guides on inference usage

Browse files

Keep model-package agent documentation focused on downloads, environment setup, inference calls, parameters, output checks and troubleshooting.

Files changed (3) hide show
  1. AGENTS.md +3 -3
  2. AGENT_GUIDE.md +4 -6
  3. CLAUDE.md +1 -1
AGENTS.md CHANGED
@@ -1,14 +1,14 @@
1
- # Iroha-TTS:agent 入口
2
 
3
  使用本模型前,先读 [AGENT_GUIDE.md](AGENT_GUIDE.md)。完整参数见
4
  [中文 model card](README_zh.md#参数说明) / [English model card](README.md#parameters),
5
  实际可用范围以本包的 [model/config.json](model/config.json) 和 `python infer.py --help` 为准。
6
 
7
- - 本包是 **Iroha-TTS-V1**:Fish S2-Pro 上的 V10.1 发布权重(V9 long-run GRPO step 250),含耳语 CFG、假名读音改写和方向向量强度接口。
8
  - 单句用 `infer.py --text`,多句优先 `--jsonl`,服务集成用 `emotts.EmotionTTS` 并复用实例。
9
  - 参考音频与其真实转写成对提供;没有参考时不能承诺固定音色。
10
  - 非零强度用显式 `--emotion` / `emotion=`,文本不写情感或副语言标签;接受四档名或当前配置范围内的有限浮点数。`0` / `default` 保留原有生成。
11
  - 使用本机已授权的 GPU、环境和输出目录;记录下载 revision、实际导入路径、输入参数及输出路径。
12
  - 成功需检查 WAV、帧数和自然结束标记;文件存在不等于内容与听感正确。具体检查见指南。
13
 
14
- 这是模型推理包的使用入口。需要训练或实验复现时,使用相应训练项目的入口和固定实验协议。
 
1
+ # Iroha-TTS:agent 推理入口
2
 
3
  使用本模型前,先读 [AGENT_GUIDE.md](AGENT_GUIDE.md)。完整参数见
4
  [中文 model card](README_zh.md#参数说明) / [English model card](README.md#parameters),
5
  实际可用范围以本包的 [model/config.json](model/config.json) 和 `python infer.py --help` 为准。
6
 
7
+ - 本包是 **Iroha-TTS-V1**,提供日语语音生成、情感控制、音色克隆、耳语、假名读音改写和方向向量强度接口;具体版本以下载的 HF revision 为准。
8
  - 单句用 `infer.py --text`,多句优先 `--jsonl`,服务集成用 `emotts.EmotionTTS` 并复用实例。
9
  - 参考音频与其真实转写成对提供;没有参考时不能承诺固定音色。
10
  - 非零强度用显式 `--emotion` / `emotion=`,文本不写情感或副语言标签;接受四档名或当前配置范围内的有限浮点数。`0` / `default` 保留原有生成。
11
  - 使用本机已授权的 GPU、环境和输出目录;记录下载 revision、实际导入路径、输入参数及输出路径。
12
  - 成功需检查 WAV、帧数和自然结束标记;文件存在不等于内容与听感正确。具体检查见指南。
13
 
14
+ 按指南完成下载、环境准备、推理调用、参数选择、结果检查和常见错误处理。
AGENT_GUIDE.md CHANGED
@@ -1,4 +1,4 @@
1
- # Iroha-TTS:给 agent 的使用指南
2
 
3
  目标:从用户的文本、参考声音和表达要求,生成可交付的日语 WAV;能准确记录所用版本、参数和结果。
4
 
@@ -8,19 +8,17 @@
8
  |---|---|
9
  | HF 模型库 | `inorispeech/Iroha-TTS` |
10
  | 对外名称 | `Iroha-TTS-V1` |
11
- | 训练权重 | 内部 V10.1 发布包,沿用 V9 long-run GRPO step 250 |
12
  | 底座 | `fishaudio/s2-pro`,revision `1de9996b6be38b745688de084d87a5633f714e4e` |
13
  | 含强度接口的代码基线 | HF commit `62836b777a3e5dfd81001cf8b5b4e987590ae0d7`;后续文档提交可以不改变代码与权重 |
14
  | 推理功能 | 四情感、句中转折、笑/叹气/哭/耳语、音色克隆、假名读音、四档或浮点数强度 |
15
- | 包与入口 | `emotts.EmotionTTS` / `infer.py`;训练项目另有 `emo_tts` 包 |
16
 
17
- Ming 属于另一条实验线。历史实验名不能用来替换用户指定的 Iroha 发布权重。
18
  读取实际下载包的 `model/config.json`;若其中没有 `intensity`,或 `infer.py --help` 没有 `--intensity`,说明本地包版本不同。
19
 
20
  ## 2. 下载并固定本次使用的 revision
21
 
22
  使用本机已配置的 HF 登录或当前用户授权的 token 来源。仓库访问受 HF 权限控制;凭据不写进代码、命令参数或运行日志。
23
- 先解析一次 `main` 得到完整 commit,再固定该 commit 下载;复现实验时直接复用已有完整 commit。
24
 
25
  以下代码使用已安装 `huggingface_hub` 的 Python,从模型目录的上一级运行。`Iroha-TTS` 应是本次使用的新目录:
26
 
@@ -98,7 +96,7 @@ CUDA_VISIBLE_DEVICES=0 .venv/bin/python infer.py \
98
  强度仍属实验功能,不能承诺听感单调、线性或音质完全不变。
99
 
100
  `guidance` 用于副语言标签,与情感方向向量不同。省略时仅耳语为 1.5;显式 `0` 全部关闭。
101
- 不要用 LoRA rank/alpha、`max_frames` 或 seed 代替强度、语速或音量控制。
102
  完整 15 个 CLI 参数及 Python 返回字段见 [参数说明](README_zh.md#参数说明) 和 [Python 调用](README_zh.md#python-调用)。
103
 
104
  ## 5. 批量与 Python 集成
 
1
+ # Iroha-TTS:agent 推理指南
2
 
3
  目标:从用户的文本、参考声音和表达要求,生成可交付的日语 WAV;能准确记录所用版本、参数和结果。
4
 
 
8
  |---|---|
9
  | HF 模型库 | `inorispeech/Iroha-TTS` |
10
  | 对外名称 | `Iroha-TTS-V1` |
 
11
  | 底座 | `fishaudio/s2-pro`,revision `1de9996b6be38b745688de084d87a5633f714e4e` |
12
  | 含强度接口的代码基线 | HF commit `62836b777a3e5dfd81001cf8b5b4e987590ae0d7`;后续文档提交可以不改变代码与权重 |
13
  | 推理功能 | 四情感、句中转折、笑/叹气/哭/耳语、音色克隆、假名读音、四档或浮点数强度 |
14
+ | 包与入口 | `emotts.EmotionTTS` / `infer.py` |
15
 
 
16
  读取实际下载包的 `model/config.json`;若其中没有 `intensity`,或 `infer.py --help` 没有 `--intensity`,说明本地包版本不同。
17
 
18
  ## 2. 下载并固定本次使用的 revision
19
 
20
  使用本机已配置的 HF 登录或当前用户授权的 token 来源。仓库访问受 HF 权限控制;凭据不写进代码、命令参数或运行日志。
21
+ 先解析一次 `main` 得到完整 commit,再固定该 commit 下载;复用同一推理版本时直接使用已记录的完整 commit。
22
 
23
  以下代码使用已安装 `huggingface_hub` 的 Python,从模型目录的上一级运行。`Iroha-TTS` 应是本次使用的新目录:
24
 
 
96
  强度仍属实验功能,不能承诺听感单调、线性或音质完全不变。
97
 
98
  `guidance` 用于副语言标签,与情感方向向量不同。省略时仅耳语为 1.5;显式 `0` 全部关闭。
99
+ `max_frames` 是生成长度上限,seed 控制随机采样;它们不是强度、语速或音量参数。
100
  完整 15 个 CLI 参数及 Python 返回字段见 [参数说明](README_zh.md#参数说明) 和 [Python 调用](README_zh.md#python-调用)。
101
 
102
  ## 5. 批量与 Python 集成
CLAUDE.md CHANGED
@@ -1,4 +1,4 @@
1
- # Iroha-TTS:Claude 入口
2
 
3
  先读取 [AGENTS.md](AGENTS.md),再按 [AGENT_GUIDE.md](AGENT_GUIDE.md) 使用模型。
4
  如果已加载同一文件,不重复递归读取。参数和运行规则共用这两份文档。
 
1
+ # Iroha-TTS:Claude 推理入口
2
 
3
  先读取 [AGENTS.md](AGENTS.md),再按 [AGENT_GUIDE.md](AGENT_GUIDE.md) 使用模型。
4
  如果已加载同一文件,不重复递归读取。参数和运行规则共用这两份文档。