update comfyui_refiners docs

Author: Laurent

docs/guides/comfyui_refiners/index.md

@@ -0,0 +1,119 @@
+---
+icon: material/vector-line
+---
+
+We provide a set of custom nodes for ComfyUI that allow you to easily use some of Refiners' models and utilities in your ComfyUI workflows.
+
+## Installation
+
+The nodes are published at <https://registry.comfy.org/publishers/finegrain/nodes/comfyui-refiners>.
+
+### Requirements
+
+1\. Install python (>=3.10):
+=== "Linux"
+    ```bash
+    sudo apt install python3
+    ```
+=== "Windows"
+    ```powershell
+    winget install -e --id Python.Python.3.11
+    ```
+
+2\. Install git:
+=== "Linux"
+    ```bash
+    sudo apt install git
+    ```
+=== "Windows"
+    ```powershell
+    winget install -e --id Git.Git
+    ```
+
+3\. (Optional) Create a python virtual environment:
+=== "Linux"
+    ```bash
+    ~/Documents/comfy$ python -m venv .venv
+    ~/Documents/comfy$ source .venv/bin/activate
+    ```
+=== "Windows"
+    ```powershell
+    PS C:\Users\Laurent\Documents\comfy> python -m venv .venv
+    PS C:\Users\Laurent\Documents\comfy> .\.venv\Scripts\activate
+    ```
+
+4\. Install [comfy-cli](https://docs.comfy.org/comfy-cli/getting-started):
+=== "Linux"
+    ```bash
+    (.venv) ~/Documents/comfy$ pip install comfy-cli
+    ```
+=== "Windows"
+    ```powershell
+    (.venv) PS C:\Users\Laurent\Documents\comfy> pip install comfy-cli
+    ```
+
+5\. Install [ComfyUI](https://github.com/comfyanonymous/ComfyUI):
+=== "Linux"
+    ```bash
+    (.venv) ~/Documents/comfy$ comfy --here install
+    ```
+=== "Windows"
+    ```powershell
+    (.venv) PS C:\Users\Laurent\Documents\comfy> comfy --here install
+    ```
+
+### Comfy Registry (recommended)
+
+1\. Install the [comfyui-refiners](https://registry.comfy.org/publishers/finegrain/nodes/comfyui-refiners) custom nodes:
+=== "Linux"
+    ```bash
+    (.venv) ~/Documents/comfy$ comfy node registry-install comfyui-refiners
+    ```
+=== "Windows"
+    ```powershell
+    (.venv) PS C:\Users\Laurent\Documents\comfy> comfy node registry-install comfyui-refiners
+    ```
+
+2\. Ensure that comfyui-refiners's dependencies are installed:
+=== "Linux"
+    ```bash
+    (.venv) ~/Documents/comfy$ pip install -r ./ComfyUI/custom_nodes/comfyui-refiners/requirements.txt
+    ```
+=== "Windows"
+    ```powershell
+    (.venv) PS C:\Users\Laurent\Documents\comfy> pip install -r .\ComfyUI\custom_nodes\comfyui-refiners\requirements.txt
+    ```
+
+3\. Start ComfyUI:
+=== "Linux"
+    ```bash
+    (.venv) ~/Documents/comfy$ comfy launch
+    ```
+=== "Windows"
+    ```powershell
+    (.venv) PS C:\Users\Laurent\Documents\comfy> comfy launch
+    ```
+
+### Manually
+
+To manually install the nodes, you may alternatively do the following:
+
+1. Download an archive of the nodes by cliking the "Download Latest" button at <https://registry.comfy.org/publishers/finegrain/nodes/comfyui-refiners>, or by running the following command:
+```shell
+curl -o comfyui-refiners.zip https://storage.googleapis.com/comfy-registry/finegrain/comfyui-refiners/1.0.4/node.tar.gz
+```
+
+2. Extract the archive to the `custom_nodes` directory:
+```shell
+unzip -d custom_nodes/comfyui-refiners comfyui-refiners.zip
+```
+
+3. Install the nodes' dependencies:
+```shell
+pip install -r custom_nodes/comfyui-refiners/requirements.txt
+```
+
+4. Remove the (now useless) downloaded archive:
+```shell
+rm comfyui-refiners.zip
+```

docs/index.md

@@ -19,6 +19,7 @@ icon: material/water-outline
   [![Discord](https://img.shields.io/discord/1179456777406922913?logo=discord&logoColor=white&color=%235765F2)](https://discord.gg/mCmjNUVV7d)
   [![HuggingFace - Refiners](https://img.shields.io/badge/refiners-ffd21e?logo=huggingface&labelColor=555)](https://huggingface.co/refiners)
   [![HuggingFace - Finegrain](https://img.shields.io/badge/finegrain-ffd21e?logo=huggingface&labelColor=555)](https://huggingface.co/finegrain)
+  [![ComfyUI Registry](https://img.shields.io/badge/ComfyUI_Registry-comfyui--refiners-1a56db)](https://registry.comfy.org/publishers/finegrain/nodes/comfyui-refiners)
 
   At the era of foundation models, adaptation is quickly rising at the method of choice for bridging the last mile quality gap.
   We couldn't find a framework with first class citizen APIs for foundation model adaptation, so we created one.

mkdocs.yml

@@ -68,6 +68,7 @@ nav:
   - Guides:
     - Adapting SDXL: guides/adapting_sdxl/index.md
     - Training 101: guides/training_101/index.md
+    - ComfyUI Refiners: guides/comfyui_refiners/index.md
   - API Reference:
       - Refiners: reference/
 extra:

src/comfyui-refiners/README.md

@@ -18,32 +18,7 @@
 
 ## Installation
 
-1. Navigate to the root of your ComfyUI workspace.
-2. Activate your python virtual environment.
-3. Install the nodes using one of the following methods.
-
-### Comfy Registry (recommended)
-
-The nodes are published at https://registry.comfy.org/publishers/finegrain/nodes/comfyui-refiners.
-
-See https://docs.comfy.org/comfy-cli/getting-started to install the Comfy CLI.
-
-To automagically install the nodes, run the following command:
-```bash
-comfy node registry-install comfyui-refiners
-```
-
-See https://docs.comfy.org/registry/overview for more information.
-
-### Manual
-
-To manually install the nodes, you may alternatively do the following:
-```bash
-curl -o comfyui-refiners.zip https://storage.googleapis.com/comfy-registry/finegrain/comfyui-refiners/1.0.3/node.tar.gz
-unzip -d custom_nodes/comfyui-refiners comfyui-refiners.zip
-pip install -r custom_nodes/comfyui-refiners/requirements.txt
-rm comfyui-refiners.zip
-```
+The nodes are published at https://registry.comfy.org/publishers/finegrain/nodes/comfyui-refiners. See our [installation guide](https://refine.rs/guides/comfyui_refiners/) for more details.
 
 ## Example Workflows