diff --git a/README.md b/README.md index 5d92c44..9e4b103 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,29 @@ Project Page Code -ComfyUI Custom Node for paper: **Chord: Chain of Rendering Decomposition for PBR Material Estimation from Generated Texture Images** +ComfyUI custom node implementation of the paper: **Chord: Chain of Rendering Decomposition for PBR Material Estimation from Generated Texture Images** ## Installation 1. Download and install ComfyUI. If you are new to ComfyUI, refer to the original [repository](https://github.com/comfyanonymous/ComfyUI) to get started. **Make sure you have the latest version.** -2. Download the pretrained model from [Hugging Face](Ubisoft/ubisoft-laforge-chord) and place the **chord_v1.ckpt** file into the **ComfyUI/models/checkpoints** folder. +2. Download the pretrained model from [Hugging Face](https://huggingface.co/Ubisoft/ubisoft-laforge-chord) and place the file **chord_v1.ckpt** in the folder **./ComfyUI/models/checkpoints**. -3. Install the custom nodes from the [ComfyUI-Manager](https://github.com/Comfy-Org/ComfyUI-Manager) or manually cloning this repository recursively in the custom nodes folder of ComfyUI: +3. Install the custom nodes from the [ComfyUI-Manager](https://github.com/Comfy-Org/ComfyUI-Manager) or manually clone this repository **with the argument `--recursive`** in the custom nodes folder of ComfyUI: ```shell - # 1. Clone repo + # Clone the repository cd ./ComfyUI/custom_nodes git clone --recursive https://github.com/ubisoft/ComfyUI-Chord.git - # 2. Install dependencies - ## For python version - cd ComfyUI-Chord - pip install -r requirements.txt - ## For windows portable version + + # Install dependencies + ## For Python version + pip install -r .\ComfyUI-Chord\requirements.txt + + ## Or for Windows portable version ..\..\python_embeded\python.exe -s -m pip install -r .\ComfyUI-Chord\requirements.txt ``` + ## Example Workflow ![Example workflow](examples/chord_example.png) @@ -34,7 +36,8 @@ You can load this workflow using the JSON file: ## License -This project is released under the **Ubisoft Machine Learning License (Research-Only - Copyleft)**. See the full terms in the [LICENSE](LICENSE) file +This project is released under the **Ubisoft Machine Learning License (Research-Only - Copyleft)**. See the full terms in the [LICENSE](LICENSE) file. + ## Citation If you find our work useful, please consider citing: