Bläddra i källkod

[docs]:fix image promblem that cannot display on website in Chinese docs (#384)

* [docx]:delete speaker param in docs

* [feature]:update docs and fix the problem that image not avaliable in website

* [fix]:fix repeat key in yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: WhaleDolphin <whaledolphin666@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Whale and Dolphin 1 år sedan
förälder
incheckning
e868a42f05
4 ändrade filer med 80 tillägg och 3 borttagningar
  1. 4 0
      docs/ja/inference.md
  2. 62 0
      docs/zh/index.md
  3. 3 0
      docs/zh/inference.md
  4. 11 3
      mkdocs.yml

+ 4 - 0
docs/ja/inference.md

@@ -50,7 +50,11 @@ python tools/llama/generate.py \
     それに対応して、加速を使用しない場合は、`--compile`パラメータをコメントアウトできます。
 
 !!! info
+<<<<<<< HEAD
+    bf16をサポートしていないGPUの場合、`--half`パラメータを使用する必要があるかもしれません。
+=======
     bf16 をサポートしていない GPU の場合、`--half`パラメータを使用する必要があるかもしれません。
+>>>>>>> upstream/main
 
 ### 3. セマンティックトークンから音声を生成する:
 

+ 62 - 0
docs/zh/index.md

@@ -18,7 +18,11 @@
 此代码库根据 `BSD-3-Clause` 许可证发布, 所有模型根据 CC-BY-NC-SA-4.0 许可证发布.
 
 <p align="center">
+<<<<<<< HEAD
+  <img src="https://s2.loli.net/2024/05/11/h9qSpRboTs5dGMQ.png" width="75%">
+=======
    <img src="/docs/assets/figs/diagram.png" width="75%">
+>>>>>>> upstream/main
 </p>
 
 ## 要求
@@ -32,6 +36,63 @@ Windows 专业用户可以考虑 WSL2 或 docker 来运行代码库。
 
 Windows 非专业用户可考虑以下为免 Linux 环境的基础运行方法(附带模型编译功能,即 `torch.compile`):
 
+<<<<<<< HEAD
+1. 解压项目压缩包。
+2. 点击 `install_env.bat` 安装环境。
+    - 可以通过编辑 `install_env.bat` 的 `USE_MIRROR` 项来决定是否使用镜像站下载。
+    - `USE_MIRROR=false` 使用原始站下载最新稳定版 `torch` 环境。`USE_MIRROR=true` 为从镜像站下载最新 `torch` 环境。默认为 `true`。
+    - 可以通过编辑 `install_env.bat` 的 `INSTALL_TYPE` 项来决定是否启用可编译环境下载。
+    - `INSTALL_TYPE=preview` 下载开发版编译环境。`INSTALL_TYPE=stable` 下载稳定版不带编译环境。
+3. 若第2步 `INSTALL_TYPE=preview` 则执行这一步(可跳过,此步为激活编译模型环境)
+    1. 使用如下链接下载 LLVM 编译器。
+        - [LLVM-17.0.6(原站站点下载)](https://huggingface.co/fishaudio/fish-speech-1/resolve/main/LLVM-17.0.6-win64.exe?download=true)
+        - [LLVM-17.0.6(镜像站点下载)](https://hf-mirror.com/fishaudio/fish-speech-1/resolve/main/LLVM-17.0.6-win64.exe?download=true)
+        - 下载完 `LLVM-17.0.6-win64.exe` 后,双击进行安装,选择合适的安装位置,最重要的是勾选 `Add Path to Current User` 添加环境变量。
+        - 确认安装完成。
+    2. 下载安装 Microsoft Visual C++ 可再发行程序包,解决潜在 .dll 丢失问题。
+        - [MSVC++ 14.40.33810.0 下载](https://aka.ms/vs/17/release/vc_redist.x64.exe)
+    3. 下载安装 Visual Studio 社区版以获取 MSVC++ 编译工具, 解决 LLVM 的头文件依赖问题。
+        - [Visual Studio 下载](https://visualstudio.microsoft.com/zh-hans/downloads/)
+        - 安装好Visual Studio Installer之后,下载Visual Studio Community 2022
+        - 如下图点击`修改`按钮,找到`使用C++的桌面开发`项,勾选下载
+<p align="center">
+   <img src="https://s2.loli.net/2024/07/15/pWdlYXNAMIzb8Lq.png" width="60%">
+</p>
+4. 双击 `start.bat`,进入 Fish-Speech 训练推理配置 WebUI 页面。
+    - (可选) 想直接进入推理页面?编辑项目根目录下的
+    -  进入网页后:
+
+<p align="center">
+  <img src="https://s2.loli.net/2024/05/06/gw2L39Qj4mClJSG.png" width="75%">
+</p>
+
+   -  简单说一下各部分区域构成,如下图所示,方便按图索骥:
+
+<p align="center">
+  <img src="https://s2.loli.net/2024/05/06/NvfsgyRZCSk72MG.png" width="75%">
+</p>
+
+   -  **1** banner(横幅):进入网页后从左到右逐渐显示"Welcome to Fish-Speech"字样。以后可能变动。
+   -  **2** 功能区: 在这里,你将决定数据集文件的来源,文本标签的修改,训练参数的调整、推理页面的设置。
+   -  **3** 文件信息展示区:一般不可更改。指引你如何找到自己的预处理后的数据文件、训练后的模型文件所在路径。
+   -  **4** 版本/作者信息。可以多多支持一下作者。
+   -  **5** 欢迎更好的动效~
+
+!!! info "可选"
+
+    想启动 API 服务器?编辑项目根目录下的 `API_FLAGS.txt`, 前三行修改成如下格式:
+    ```
+    # --infer
+        --api
+        --listen ...
+        ...
+    ```
+
+!!! info "可选"
+    
+    双击 `run_cmd.bat` 进入本项目的 conda/python 命令行环境
+
+=======
 <ol>
    <li>解压项目压缩包。</li>
    <li>点击 install_env.bat 安装环境。
@@ -88,6 +149,7 @@ Windows 非专业用户可考虑以下为免 Linux 环境的基础运行方法
    </li>
    <li>(可选)双击 <code>run_cmd.bat</code> 进入本项目的 conda/python 命令行环境</li>
 </ol>
+>>>>>>> upstream/main
 
 ## Linux 配置
 

+ 3 - 0
docs/zh/inference.md

@@ -58,7 +58,10 @@ python tools/llama/generate.py \
 !!! info
     对于不支持 bf16 的 GPU, 你可能需要使用 `--half` 参数.
 
+<<<<<<< HEAD
+=======
 ### 3. 从语义 token 生成人声:
+>>>>>>> upstream/main
 
 #### VQGAN 解码
 

+ 11 - 3
mkdocs.yml

@@ -17,6 +17,7 @@ theme:
     - content.action.edit
     - content.action.view
     - navigation.tracking
+    - navigation.footer
     # - navigation.tabs
     - search
     - search.suggest
@@ -52,9 +53,6 @@ theme:
       primary: black
       font:
         code: Roboto Mono
-  
-extra:
-  homepage: https://speech.fish.audio
 
 # Plugins
 plugins:
@@ -94,3 +92,13 @@ markdown_extensions:
 
 extra_css:
   - stylesheets/extra.css
+
+extra:
+  social:
+    - icon: fontawesome/brands/discord
+      link: https://discord.gg/Es5qTB9BcN
+    - icon: fontawesome/brands/docker
+      link: https://hub.docker.com/r/lengyue233/fish-speech
+    - icon: fontawesome/brands/qq
+      link: http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=jCKlUP7QgSm9kh95UlBoYv6s1I-Apl1M&authKey=xI5ttVAp3do68IpEYEalwXSYZFdfxZSkah%2BctF5FIMyN2NqAa003vFtLqJyAVRfF&noverify=0&group_code=593946093
+  homepage: https://speech.fish.audio