comfyui-workflow-templates 0.1.1__tar.gz → 0.1.2__tar.gz

{comfyui_workflow_templates-0.1.1/comfyui_workflow_templates.egg-info → comfyui_workflow_templates-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comfyui_workflow_templates
-Version: 0.1.1
+Version: 0.1.2
 Summary: ComfyUI workflow templates package
 Author: Comfy-Org
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -686,24 +686,24 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
 
-- [workflow\_templates](#workflow_templates)
-  - [Adding New Templates](#adding-new-templates)
-    - [1 — Find Templates Folder](#1--find-templates-folder)
-    - [2 — Obtain Workflow](#2--obtain-workflow)
-    - [3 — Obtain Thumbnails](#3--obtain-thumbnails)
-    - [4 — Choose Thumbnail Type](#4--choose-thumbnail-type)
-    - [5 — Rename and Move Files](#5--rename-and-move-files)
-    - [6 — Add Entry to `index.json`](#6--add-entry-to-indexjson)
-    - [7 — Embed Models](#7--embed-models)
-    - [8 — Embed Node Versions (optional)](#8--embed-node-versions-optional)
-    - [9 — Add Documentation Nodes (optional)](#9--add-documentation-nodes-optional)
-    - [9 — Create PR](#9--create-pr)
-    - [10 — Add Translations](#10--add-translations)
-
 # workflow_templates
 
 ComfyUI workflow templates hosted under <https://github.com/Comfy-Org/ComfyUI_frontend/tree/main/public>.
 
+- [Adding New Templates](#adding-new-templates)
+  - [1 — Find Templates Folder](#1--find-templates-folder)
+  - [2 — Obtain Workflow](#2--obtain-workflow)
+  - [3 — Obtain Thumbnails](#3--obtain-thumbnails)
+  - [4 — Choose Thumbnail Type](#4--choose-thumbnail-type)
+  - [5 — Compress Assets](#5--compress-assets)
+  - [6 — Rename and Move Files](#6--rename-and-move-files)
+  - [7 — Add Entry to `index.json`](#7--add-entry-to-indexjson)
+  - [8 — Embed Models](#8--embed-models)
+  - [9 — Embed Node Versions (optional)](#9--embed-node-versions-optional)
+  - [10 — Add Documentation Nodes (optional)](#10--add-documentation-nodes-optional)
+  - [11 — Bump Version and Create PR](#11--bump-version-and-create-pr)
+  - [12 — Add Translations](#12--add-translations)
+
 ## Adding New Templates
 
 I will demonstrate how to add a new template by walking through the process of adding the Wan text to video template.
@@ -757,8 +757,8 @@ For my Wan 2.1 template, I'll just use [the webp video](https://comfyanonymous.g
 
 Choose the content type and hover effect (optional) for your thumbnail:
 
-| Content Types                                                                                                   | Hover Effects                                                                                                       |
-| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| Content Types                                                                                                   | Hover Effects                                                                                                                |
+| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
 | ![Image Element](docs/pictures/thumbnail-variants/default.gif)<br>**Image**: Default image with no extra effect | ![Compare Slider](docs/pictures/thumbnail-variants/compare-slider.gif)<br>**Compare Slider**: Before/after comparison tool   |
 | ![Video Player](docs/pictures/thumbnail-variants/video.gif)<br>**Video**: Webp animation                        | ![Hover Dissolve](docs/pictures/thumbnail-variants/hover-disolve.gif)<br>**Hover Dissolve**: Dissolves to 2nd image on hover |
 | ![Audio Controls](docs/pictures/thumbnail-variants/audio.gif)<br>**Audio**: Audio playback                      | ![Hover Zoom](docs/pictures/thumbnail-variants/hover-zoom.gif)<br>**Hover Zoom**: Same as default but zooms more             |
@@ -769,7 +769,17 @@ Choose the content type and hover effect (optional) for your thumbnail:
 
 Since my Wan 2.1 thumbnail is already an animated video, I'll use a video thumbnail but choose not to add an effect.
 
-### 5 — Rename and Move Files
+### 5 — Compress Assets
+
+Attempt to compress the assets. Since the thumbnails will never be taking up a large portion of the screen, it is acceptable to lower their size. It's also good to convert them to a space-efficient file format like webp or jpeg, applying a lossy compression algorithm (e.g., convert at 65% quality).
+
+[EzGif](https://ezgif.com/png-to-webp) has free tools for changing resolution, compressing, and converting file types. Use whatever tool you are comfortable with.
+
+> [!TIP]
+>
+> Convert to webp first, then resize to a smaller resolution. You can maintain high quality and still get near 95% reduction if e.g., converting from png.
+
+### 6 — Rename and Move Files
 
 Give the workflow a filename that has no spaces, dots, or special characters. Then rename the thumbnail file(s) to match, but with a counter suffix.
 
@@ -788,7 +798,7 @@ text_to_video_wan-1.webp
 
 Then move the renamed files to your templates folder.
 
-### 6 — Add Entry to `index.json`
+### 7 — Add Entry to `index.json`
 
 There's an [`index.json`](templates/index.json) file in the templates folder which is where template configurations are set. You will need to add your template to this file, using the fields outlined below:
 
@@ -858,7 +868,7 @@ Now you can start ComfyUI (or refresh browser if already running) and test that
 >
 > Make sure to use double-quotes `"` instead of single-quotes `'` when adding things to json files
 
-### 7 — Embed Models
+### 8 — Embed Models
 
 Now we need to embed metadata for any models the template workflow uses. This way, the user can download and run the workflow without ever leaving ComfyUI.
 
@@ -896,6 +906,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "wan_2.1_vae.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors?download=true",
++           "hash": "2fc39d31359a4b0a64f55876d8ff7fa8d780956ae2cb13463b0223e15148976b"
++           "hash_type": "SHA256",
 +           "directory": "vae"
 +         }
 +       ]
@@ -928,6 +940,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "umt5_xxl_fp8_e4m3fn_scaled.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_encoders/umt5_xxl_fp8_e4m3fn_scaled.safetensors?download=true",
++           "hash": "c3355d30191f1f066b26d93fba017ae9809dce6c627dda5f6a66eaa651204f68",
++           "hash_type": "SHA256",
 +           "directory": "text_encoders"
 +         }
 +       ]
@@ -964,6 +978,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "wan2.1_t2v_1.3B_bf16.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_bf16.safetensors?download=true",
++           "hash": "6f999b0d6cb9a72b3d98ac386ed96f57f8cecae13994a69232514ea4974ad5fd",
++           "hash_type": "SHA256",
 +           "directory": "diffusion_models"
 +         }
 +       ]
@@ -972,25 +988,17 @@ To add them to the workflow json, find each associated node and add the metadata
     },
 ```
 
-You can also specify the model hash if appropriate:
+You can find the `hash` and `hash_type` for a model on huggingface (see below)or by calculating it yourself with a script or online tool.
 
-```json
-{
-  "name": "wan2.1_t2v_1.3B_bf16.safetensors",
-  "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_bf16.safetensors?download=true",
-  "directory": "diffusion_models",
-  "hash": "8743b52063cd84097a65d1633f5c74f5",
-  "hash_type": "MD5"
-}
-```
+![finding hash on hugginface](docs/pictures/finding-hugginface-hash.png)
 
-[Workflow spec](https://docs.comfy.org/specs/workflow_json#workflow-json) for more details.
+[Workflow spec](https://docs.comfy.org/specs/workflow_json#workflow-json) and [ModelFile Zod schema](https://github.com/Comfy-Org/ComfyUI_frontend/blob/6bc03a624ecbc0439501d0c7c2b073ca90e9a742/src/schemas/comfyWorkflowSchema.ts#L34-L40) for more details.
 
 > [!CAUTION]
 >
 > Ensure that the filename being downloaded from the links matches the filenames in the `widgets_values` exactly.
 
-### 8 — Embed Node Versions (optional)
+### 9 — Embed Node Versions (optional)
 
 If your template requires a specific version of Comfy or a custom node, you can specify that using the same process as with models.
 
@@ -1024,7 +1032,7 @@ The Wan 2.1 workflow requires the SaveWEBM node which wasn't fully supported unt
 
 This can help diagnose issues when others run the workflow and ensure the workflow is more reproducible.
 
-### 9 — Add Documentation Nodes (optional)
+### 10 — Add Documentation Nodes (optional)
 
 If your template corresponds with a page on https://github.com/comfyanonymous/ComfyUI_examples, https://docs.comfy.org/custom-nodes/workflow_templates, etc., you can add a `MarkdownNote` node with links:
 
@@ -1040,19 +1048,22 @@ Raw markdown used:
 > [Wan 2.1 Tutorial - docs.comfy.org](https://docs.comfy.org/advanced/wan-video) — Explanation of concepts and step-by-step tutorial
 ```
 
-### 9 — Create PR
+### 11 — Bump Version and Create PR
 
 1. Fully test the workflow: delete the models, input images, etc. and try it as a new user would. Ensure the process ahs no hiccups and you can generate the thumbnail image on the first execution (if applicable).
 2. Create a fork of https://github.com/Comfy-Org/workflow_templates
 3. Clone the fork to your system
 4. Copy your new workflow and thumbnail(s) into the `templates` folder
 5. Add your changes to the `templates/index.json` file
-6. Commit and push changes
-7. Create a PR on https://github.com/Comfy-Org/workflow_templates
+6. Bump the version in `pyproject.toml` ([example](https://github.com/Comfy-Org/workflow_templates/pull/32))
+7. Commit and push changes
+8. Create a PR on https://github.com/Comfy-Org/workflow_templates
 
 Here is the PR I made for the Wan template: https://github.com/Comfy-Org/workflow_templates/pull/16
 
-### 10 — Add Translations
+Once the PR is merged, if you followed step 6 correctly, a new version will be published to the [comfyui-workflow-templates PyPi package](https://pypi.org/project/comfyui-workflow-templates).
+
+### 12 — Add Translations
 
 Make a PR in https://github.com/Comfy-Org/ComfyUI_frontend adding the mapping from your template filename (without extension) to the English display name title. The mapping goes in [`ComfyUI_frontend/src/locales/en/main.json`](https://github.com/Comfy-Org/ComfyUI_frontend/blob/9f0abac57ba0d5752c51198bf8a075b8336fdda1/src/locales/en/main.json#L480-L487).
 

{comfyui_workflow_templates-0.1.1 → comfyui_workflow_templates-0.1.2}/README.md

@@ -1,21 +1,21 @@
-- [workflow\_templates](#workflow_templates)
-  - [Adding New Templates](#adding-new-templates)
-    - [1 — Find Templates Folder](#1--find-templates-folder)
-    - [2 — Obtain Workflow](#2--obtain-workflow)
-    - [3 — Obtain Thumbnails](#3--obtain-thumbnails)
-    - [4 — Choose Thumbnail Type](#4--choose-thumbnail-type)
-    - [5 — Rename and Move Files](#5--rename-and-move-files)
-    - [6 — Add Entry to `index.json`](#6--add-entry-to-indexjson)
-    - [7 — Embed Models](#7--embed-models)
-    - [8 — Embed Node Versions (optional)](#8--embed-node-versions-optional)
-    - [9 — Add Documentation Nodes (optional)](#9--add-documentation-nodes-optional)
-    - [9 — Create PR](#9--create-pr)
-    - [10 — Add Translations](#10--add-translations)
-
 # workflow_templates
 
 ComfyUI workflow templates hosted under <https://github.com/Comfy-Org/ComfyUI_frontend/tree/main/public>.
 
+- [Adding New Templates](#adding-new-templates)
+  - [1 — Find Templates Folder](#1--find-templates-folder)
+  - [2 — Obtain Workflow](#2--obtain-workflow)
+  - [3 — Obtain Thumbnails](#3--obtain-thumbnails)
+  - [4 — Choose Thumbnail Type](#4--choose-thumbnail-type)
+  - [5 — Compress Assets](#5--compress-assets)
+  - [6 — Rename and Move Files](#6--rename-and-move-files)
+  - [7 — Add Entry to `index.json`](#7--add-entry-to-indexjson)
+  - [8 — Embed Models](#8--embed-models)
+  - [9 — Embed Node Versions (optional)](#9--embed-node-versions-optional)
+  - [10 — Add Documentation Nodes (optional)](#10--add-documentation-nodes-optional)
+  - [11 — Bump Version and Create PR](#11--bump-version-and-create-pr)
+  - [12 — Add Translations](#12--add-translations)
+
 ## Adding New Templates
 
 I will demonstrate how to add a new template by walking through the process of adding the Wan text to video template.
@@ -69,8 +69,8 @@ For my Wan 2.1 template, I'll just use [the webp video](https://comfyanonymous.g
 
 Choose the content type and hover effect (optional) for your thumbnail:
 
-| Content Types                                                                                                   | Hover Effects                                                                                                       |
-| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| Content Types                                                                                                   | Hover Effects                                                                                                                |
+| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
 | ![Image Element](docs/pictures/thumbnail-variants/default.gif)<br>**Image**: Default image with no extra effect | ![Compare Slider](docs/pictures/thumbnail-variants/compare-slider.gif)<br>**Compare Slider**: Before/after comparison tool   |
 | ![Video Player](docs/pictures/thumbnail-variants/video.gif)<br>**Video**: Webp animation                        | ![Hover Dissolve](docs/pictures/thumbnail-variants/hover-disolve.gif)<br>**Hover Dissolve**: Dissolves to 2nd image on hover |
 | ![Audio Controls](docs/pictures/thumbnail-variants/audio.gif)<br>**Audio**: Audio playback                      | ![Hover Zoom](docs/pictures/thumbnail-variants/hover-zoom.gif)<br>**Hover Zoom**: Same as default but zooms more             |
@@ -81,7 +81,17 @@ Choose the content type and hover effect (optional) for your thumbnail:
 
 Since my Wan 2.1 thumbnail is already an animated video, I'll use a video thumbnail but choose not to add an effect.
 
-### 5 — Rename and Move Files
+### 5 — Compress Assets
+
+Attempt to compress the assets. Since the thumbnails will never be taking up a large portion of the screen, it is acceptable to lower their size. It's also good to convert them to a space-efficient file format like webp or jpeg, applying a lossy compression algorithm (e.g., convert at 65% quality).
+
+[EzGif](https://ezgif.com/png-to-webp) has free tools for changing resolution, compressing, and converting file types. Use whatever tool you are comfortable with.
+
+> [!TIP]
+>
+> Convert to webp first, then resize to a smaller resolution. You can maintain high quality and still get near 95% reduction if e.g., converting from png.
+
+### 6 — Rename and Move Files
 
 Give the workflow a filename that has no spaces, dots, or special characters. Then rename the thumbnail file(s) to match, but with a counter suffix.
 
@@ -100,7 +110,7 @@ text_to_video_wan-1.webp
 
 Then move the renamed files to your templates folder.
 
-### 6 — Add Entry to `index.json`
+### 7 — Add Entry to `index.json`
 
 There's an [`index.json`](templates/index.json) file in the templates folder which is where template configurations are set. You will need to add your template to this file, using the fields outlined below:
 
@@ -170,7 +180,7 @@ Now you can start ComfyUI (or refresh browser if already running) and test that
 >
 > Make sure to use double-quotes `"` instead of single-quotes `'` when adding things to json files
 
-### 7 — Embed Models
+### 8 — Embed Models
 
 Now we need to embed metadata for any models the template workflow uses. This way, the user can download and run the workflow without ever leaving ComfyUI.
 
@@ -208,6 +218,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "wan_2.1_vae.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors?download=true",
++           "hash": "2fc39d31359a4b0a64f55876d8ff7fa8d780956ae2cb13463b0223e15148976b"
++           "hash_type": "SHA256",
 +           "directory": "vae"
 +         }
 +       ]
@@ -240,6 +252,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "umt5_xxl_fp8_e4m3fn_scaled.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_encoders/umt5_xxl_fp8_e4m3fn_scaled.safetensors?download=true",
++           "hash": "c3355d30191f1f066b26d93fba017ae9809dce6c627dda5f6a66eaa651204f68",
++           "hash_type": "SHA256",
 +           "directory": "text_encoders"
 +         }
 +       ]
@@ -276,6 +290,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "wan2.1_t2v_1.3B_bf16.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_bf16.safetensors?download=true",
++           "hash": "6f999b0d6cb9a72b3d98ac386ed96f57f8cecae13994a69232514ea4974ad5fd",
++           "hash_type": "SHA256",
 +           "directory": "diffusion_models"
 +         }
 +       ]
@@ -284,25 +300,17 @@ To add them to the workflow json, find each associated node and add the metadata
     },
 ```
 
-You can also specify the model hash if appropriate:
+You can find the `hash` and `hash_type` for a model on huggingface (see below)or by calculating it yourself with a script or online tool.
 
-```json
-{
-  "name": "wan2.1_t2v_1.3B_bf16.safetensors",
-  "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_bf16.safetensors?download=true",
-  "directory": "diffusion_models",
-  "hash": "8743b52063cd84097a65d1633f5c74f5",
-  "hash_type": "MD5"
-}
-```
+![finding hash on hugginface](docs/pictures/finding-hugginface-hash.png)
 
-[Workflow spec](https://docs.comfy.org/specs/workflow_json#workflow-json) for more details.
+[Workflow spec](https://docs.comfy.org/specs/workflow_json#workflow-json) and [ModelFile Zod schema](https://github.com/Comfy-Org/ComfyUI_frontend/blob/6bc03a624ecbc0439501d0c7c2b073ca90e9a742/src/schemas/comfyWorkflowSchema.ts#L34-L40) for more details.
 
 > [!CAUTION]
 >
 > Ensure that the filename being downloaded from the links matches the filenames in the `widgets_values` exactly.
 
-### 8 — Embed Node Versions (optional)
+### 9 — Embed Node Versions (optional)
 
 If your template requires a specific version of Comfy or a custom node, you can specify that using the same process as with models.
 
@@ -336,7 +344,7 @@ The Wan 2.1 workflow requires the SaveWEBM node which wasn't fully supported unt
 
 This can help diagnose issues when others run the workflow and ensure the workflow is more reproducible.
 
-### 9 — Add Documentation Nodes (optional)
+### 10 — Add Documentation Nodes (optional)
 
 If your template corresponds with a page on https://github.com/comfyanonymous/ComfyUI_examples, https://docs.comfy.org/custom-nodes/workflow_templates, etc., you can add a `MarkdownNote` node with links:
 
@@ -352,19 +360,22 @@ Raw markdown used:
 > [Wan 2.1 Tutorial - docs.comfy.org](https://docs.comfy.org/advanced/wan-video) — Explanation of concepts and step-by-step tutorial
 ```
 
-### 9 — Create PR
+### 11 — Bump Version and Create PR
 
 1. Fully test the workflow: delete the models, input images, etc. and try it as a new user would. Ensure the process ahs no hiccups and you can generate the thumbnail image on the first execution (if applicable).
 2. Create a fork of https://github.com/Comfy-Org/workflow_templates
 3. Clone the fork to your system
 4. Copy your new workflow and thumbnail(s) into the `templates` folder
 5. Add your changes to the `templates/index.json` file
-6. Commit and push changes
-7. Create a PR on https://github.com/Comfy-Org/workflow_templates
+6. Bump the version in `pyproject.toml` ([example](https://github.com/Comfy-Org/workflow_templates/pull/32))
+7. Commit and push changes
+8. Create a PR on https://github.com/Comfy-Org/workflow_templates
 
 Here is the PR I made for the Wan template: https://github.com/Comfy-Org/workflow_templates/pull/16
 
-### 10 — Add Translations
+Once the PR is merged, if you followed step 6 correctly, a new version will be published to the [comfyui-workflow-templates PyPi package](https://pypi.org/project/comfyui-workflow-templates).
+
+### 12 — Add Translations
 
 Make a PR in https://github.com/Comfy-Org/ComfyUI_frontend adding the mapping from your template filename (without extension) to the English display name title. The mapping goes in [`ComfyUI_frontend/src/locales/en/main.json`](https://github.com/Comfy-Org/ComfyUI_frontend/blob/9f0abac57ba0d5752c51198bf8a075b8336fdda1/src/locales/en/main.json#L480-L487).