From 2df68f540c4de84f25bb2ac329d221db0e271db0 Mon Sep 17 00:00:00 2001 From: smthemex <138738845+smthemex@users.noreply.github.com> Date: Wed, 24 Apr 2024 18:46:45 +0800 Subject: [PATCH] Update README.md add text --- README.md | 85 ++++++++++++++++++------------------------------------- 1 file changed, 27 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 469e573..30be3b6 100644 --- a/README.md +++ b/README.md @@ -1,101 +1,70 @@ # ComfyUI_ParlerTTS -This is a simple ComfyUI custom TTS node based on Parler_tts. -Now you can using TTS audio for “ComfyUI-VideoHelperSuite node” +This is a simple ComfyUI custom TTS node based on Parler_tts. Now you can using TTS audio for “ComfyUI-VideoHelperSuite node” -Notice: +1.Notice: ------ -You can find the project for Parler-TTS here: [Parler-TTS](https://github.com/huggingface/parler-tts) +You can find the project for Parler-TTS here: [Parler-TTS](https://github.com/huggingface/parler-tts) It is known that there may be library file conflicts, causing some ComfyUI node to be unusabl To prevent the dependency of this plugin from affecting other comfyui plugins, I suggest the version of the "protobuf" library=3.20.3 because other versions will affect the "tensorflow-intel" library. -USING TIPS: +已知会有库文件冲突,导致某些ComfyUI 插件无法使用,为了防止此插件的依赖影响其他comfyui插件,我建议“ protobuf”库的版本==3.20.3 因为其他版本会影响“tensorflow-intel”库 + +2.Installation ----- -已知会有库文件冲突,导致某些ComfyUI 插件无法使用 -It is known that there may be library file conflicts, causing some ComfyUI node to be unusabl . - -Example: -为了防止此插件的依赖影响其他comfyui插件,我建议“ protobuf”库的版本==3.20.3 因为其他版本会影响“tensorflow-intel”库 - -To prevent the dependency of this plugin from affecting other comfyui plugins, I suggest the version of the "protobuf" library=3.20.3 because other versions will affect the "tensorflow-intel" library - - -1.Installation ------ - 1.1 In the .\ComfyUI \ custom_node directory, run the following: +2.1 In the .\ComfyUI \ custom_node directory, run the following: ``` python git clone https://github.com/smthemex/ComfyUI_ParlerTTS.git ``` +2.2 install dependencies -1.2 install dependencies ----- - -安装前的注意事项 Precautions before installation: ----- - +安装前的注意事项 这个插件的核心库是“descript-audiotools”,其 torch需求依赖较低,如果安装此方法的安装依赖,则会导致 类似torch==2.2.2+cu121的高版本torch被卸载,所以,如果你要使用 例如torch==2.2.2+cu121的高版本torch,则需要使用pip重新安装一次torch==2.2.2+cu121 +Precautions before installation: The core library of this node is "descript-audiotools", and its torch dependency is relatively low. If you install the installation dependency of this method, it will cause a higher version torch like torch=2.2.2+cu121 to be uninstalled. Therefore, if you want to use a higher version torch like torch=2.2.2+cu121, you need to use pip to reinstall torch=2.2.2+cu121 once -以下都不是最终的需求库安装解决方法 -The following are not the final solution for installing the requirement library: ------ +2.3 特殊安装情况 +以下都不是最终的需求库安装解决方法 (The following are not the final solution for installing the requirement library:) -method A ------ -如果你安装的comfyUI方式是,git clone ...,也就是不是整合包,你可以使用 - -If the comfyUI method you installed is git clone, That is not a portable comfyui, you can use it +method A: +如果你安装的comfyUI方式是,git clone ...,也就是不是整合包,你可以使用 +If the comfyUI method you installed is git clone, That is not a portable comfyui, you can use it ``` python pip install git+https://github.com/huggingface/parler-tts.git ``` -method B ------ +method B: 如果你安装的comfyui是整合包,你需要在comfyui的python_embeded的目录下,执行如下代码安装依赖库 ,安装库文件,注意替换X为你的实际路径: - if the comfyui you are installing is a portable comfyui, you need to execute the following code in the python_embed directory of comfyui to install the dependency library,please replace X with your actual path: ``` python pip install -r requirements.txt --target="path like X:\ComfyUI_windows\python_embeded\Lib\site-packages" ``` requirements文字暂时未列出,我提供以下方法,安装库文件,注意替换X为你的实际路径: - The requirements text is not currently listed. I provide the following method to install the library file, please replace X with your actual path: ``` python pip install descript-audiotools --target="X:\ComfyUI_windows\python_embeded\Lib\site-packages" ``` 可能的步骤: pip install torch (假设你现在正在使用的是高版本的torch) ,如果protobuf库报错,安装版本==3.20.3 - Possible steps: pip install torch (assuming you are currently using a higher version of torch), if the protobuf library reports an error, install version=3.20.3 - 1.3 Download the model and use it - - Model download method 1: Use model_path(repo_id) download directly - ---- - - ![](https://github.com/smthemex/ComfyUI_ParlerTTS/blob/main/output/example1.png) - - Model download method 2:如果无法直连huggingface - --- - - 方法a,直接浏览器下载模型: - - 下载[link](https://huggingface.co/parler-tts/parler_tts_mini_v0.1/tree/main)所有文件到一个你喜欢的的路径,路径名不要有中文,路径所有“\”要换成“/”,在model_path填写你的路径,例如 X:/XX/XXX,关闭get_model_online,即可使用。 +2.4 Download the model and use it +Model download method 1: +keep “get_model_onlin” is Ture ,Use repo_id download form huggingface directly - 方法B,使用内置的模型下载节点:(比如你懒得去浏览器下载) - - 把主节点的model_path转为输入,然后链接模型下载节点,模型默认下载至comfyUI的diffuse目录下(你也可以改成任何你喜欢的),其他参数不要动,注意hf_mirror是开启的,不然下载速度会很慢或者直接下载不了。 等下载完成即可使用,下次再用也不用再使用节点,直接用默认的主节点即可。 - -2.Example +模型下载方法 2:(如果无法直连huggingface ) +方法a,浏览器下载[link](https://huggingface.co/parler-tts/parler_tts_mini_v0.1/tree/main)所有文件到一个你喜欢的的路径,路径名不要有中文,路径所有“\”要换成“/”,在model_path填写你的路径,例如 X:/XX/XXX,关闭get_model_online,即可使用。 +方法B,使用我另一个模型下载节点:(比如你不会去浏览器下载) +把主节点的model_path转为输入,然后链接模型下载节点,模型默认下载至comfyUI的diffuse目录下(你也可以改成任何你喜欢的),其他参数不要动, 等下载完成即可使用,根据自己的需求看是不是用symlinks. + +3.Example ------- -![](https://github.com/smthemex/ComfyUI_ParlerTTS/blob/main/output/example.png) -![](https://github.com/smthemex/ComfyUI_ParlerTTS/blob/main/output/example1.png) +![](https://github.com/smthemex/ComfyUI_ParlerTTS/blob/main/example.png) -Citation +4.Citation ------ If you found this repository useful, please consider citing this work and also the original Stability AI paper: - ``` python @misc{lacombe-etal-2024-parler-tts, author = {Yoach Lacombe and Vaibhav Srivastav and Sanchit Gandhi},