Update README.md

README.md

@@ -4,23 +4,48 @@ base_model:
 - ByteDance-Seed/SeedVR2-3B
 - ByteDance-Seed/SeedVR2-7B
 ---
+
 # ComfyUI-SeedVR2_VideoUpscaler
 
 [![View Code](https://img.shields.io/badge/📂_View_Code-GitHub-181717?style=for-the-badge&logo=github)](https://github.com/numz/ComfyUI-SeedVR2_VideoUpscaler)
 
 Official release of [SeedVR2](https://github.com/ByteDance-Seed/SeedVR) for ComfyUI that enables Upscale Video/Images generation.
 
-<img src="https://github.com/numz/ComfyUI-SeedVR2_VideoUpscaler/raw/main/docs/demo_01.jpg">
-<img src="https://github.com/numz/ComfyUI-SeedVR2_VideoUpscaler/raw/main/docs/demo_02.jpg">
+<img src="docs/demo_01.jpg">
+<img src="docs/demo_02.jpg">
+
+<img src="docs/usage.png">
 
-<img src="https://github.com/numz/ComfyUI-SeedVR2_VideoUpscaler/raw/main/docs/usage.png">
+## 📋 Quick Access
 
-## 🆙 Todo
+- [🆙 Note and futur releases](#-note-and-futur-releases)
+- [🚀 Updates](#-updates)
+- [🎯 Features](#-features)
+- [🔧 Requirements](#-requirements)
+- [📦 Installation](#-installation)
+- [📖 Usage](#-usage)
+- [📊 Benchmarks](#-benchmarks)
+- [⚠️ Limitations](#-Limitations)
+- [🤝 Contributing](#-contributing)
+- [🙏 Credits](#-credits)
+- [📄 License](#-license)
 
-- Fixed unloading the 3B model when the process is finished (sorry about that, I'm trying to find out what's going on)
+## 🆙 Note and futur releases
+
+- Improve FP8 integration, we are loosing some FP8 advantages during the process.
+- Tile-VAE integration if it works for video, I have test to do or if some dev want help, you are welcome.
+- 7B FP8 model seems to have quality issues, use 7BFP16 instead (If FP8 don't give OOM then FP16 will works) I have to review this.
 
 ## 🚀 Updates
 
+**2025.06.30**
+
+- 🚀 Speed Up the process and less VRAM used (see new benchmark).
+- 🛠️ Fixed leak memory on 3B models.
+- ❌ Can now interrupt process if needed.
+- ✅ refactored the code for better sharing with the community, feel free to propose pull requests.
+- 🛠️ Removed flash attention dependency
+
 **2025.06.24**
 
 - 🚀 Speed up the process until x4 (see new benchmark)
@@ -36,18 +61,18 @@ Official release of [SeedVR2](https://github.com/ByteDance-Seed/SeedVR) for Comf
 
 - 🛠️ Initial push
 
-## Features
+## 🎯 Features
 
 - High-quality Upscaling
 - Suitable for any video length once the right settings are found
 - Model Will Be Download Automatically from [Models](https://huggingface.co/numz/SeedVR2_comfyUI/tree/main)
 
-## Requirements
+## 🔧 Requirements
 
 - A Huge VRAM capabilities is better, from my test, even the 3B version need a lot of VRAM at least 18GB.
 - Last ComfyUI version with python 3.12.9 (may be works with older versions but I haven't test it)
 
-## Installation
+## 📦 Installation
 
 1. Clone this repository into your ComfyUI custom nodes directory:
 
@@ -64,27 +89,21 @@ load venv and :
 pip install -r ComfyUI-SeedVR2_VideoUpscaler/requirements.txt
 ```
 
-install flash_attn or triton if it ask for it
+install flash_attn/triton, 6% faster on process, not a mandatory.
 
 ```bash
 pip install flash_attn
 pip install triton
 ```
 
-or from https://github.com/loscrossos/lib_flashattention/releases
-and
-https://github.com/woct0rdho/triton-windows
-
-Or use python_embeded :
-
-```bash
-python_embeded\python.exe -m pip install -r ComfyUI-SeedVR2_VideoUpscaler/requirements.txt
-```
+or
 
 ```bash
 python_embeded\python.exe -m pip install -r flash_attn
 ```
 
+check here from https://github.com/loscrossos/lib_flashattention/releases and https://github.com/woct0rdho/triton-windows
+
 3. Models
 
    Will be automtically download into :
@@ -92,71 +111,120 @@ python_embeded\python.exe -m pip install -r flash_attn
 
    or can be found here ([MODELS](https://huggingface.co/numz/SeedVR2_comfyUI/tree/main))
 
-## Usage
+## 📖 Usage
 
 1. In ComfyUI, locate the **SeedVR2 Video Upscaler** node in the node menu.
 
-<img src="https://github.com/numz/ComfyUI-SeedVR2_VideoUpscaler/raw/main/docs/node.png" width="100%">
+<img src="docs/node.png" width="100%">
+
+2. ⚠️ **THINGS TO KNOW !!**
 
-2. things to know
+**temporal consistency** : at least a **batch_size** of 5 is required to activate temporal consistency. SEEDVR2 need at least 5 frames to calculate it. A higher batch_size give better performances/results but need more than 24GB VRAM.
 
-**temporal consistency** : at least a batch_size of 5 is required to activate temporal consistency
+**VRAM usage** : The input video resolution impacts VRAM consumption during the process. The larger the input video, the more VRAM will consume during the process. So, if you experience OOMs with a batch_size of at least 5, try reducing the input video resolution until it resolves.
 
-2. Configure the node parameters:
+Of course, the output resolution also has an impact, so if your hardware doesn't allow it, reduce the output resolution.
+
+3. Configure the node parameters:
 
    - `model`: Select your 3B or 7B model
    - `seed`: a seed but it generate another seed from this one
-   - `new_width`: New desired Width, will keep ration on height
-   - `cfg_scale`:
-   - `batch_size`: VERY IMPORTANT!, this model consume a lot of VRAM, All your VRAM, even for the 3B model, so for GPU under 24GB VRAM keep this value Low, good value is "1" without temporal consistency
+   - `new_resolution`: New desired short edge in px, will keep ratio on other edge
+   - `batch_size`: VERY IMPORTANT!, this model consume a lot of VRAM, All your VRAM, even for the 3B model, so for GPU under 24GB VRAM keep this value Low, good value is "1" without temporal consistency, "5" for temporal consistency, but higher is this value better is the result.
    - `preserve_vram`: for VRAM < 24GB, If true, It will unload unused models during process, longer but works, otherwise probably OOM with
 
-## Performance
-
-**NVIDIA H100 93GB VRAM** (values in parentheses are from the previous benchmark):
-
-| nb frames | Resolution          | Batch Size | Time fp8 (s)     | FPS fp8     | Time fp16 (s)    | FPS fp16    |
-| --------- | ------------------- | ---------- | ---------------- | ----------- | ---------------- | ----------- |
-| 3         | 512×768 → 1080×1620 | 1          | 10.18 (58.10)    | 0.29 (0.05) | 10.67 (60.13)    | 0.28 (0.05) |
-| 15        | 512×768 → 1080×1620 | 5          | 26.71 (135.63)   | 0.56 (0.11) | 27.75 (144.18)   | 0.54 (0.10) |
-| 27        | 512×768 → 1080×1620 | 9          | 33.97 (163.22)   | 0.79 (0.17) | 35.08 (177.61)   | 0.77 (0.15) |
-| 39        | 512×768 → 1080×1620 | 13         | 41.01 (189.36)   | 0.95 (0.21) | 42.08 (210.11)   | 0.93 (0.19) |
-| 51        | 512×768 → 1080×1620 | 17         | 48.12 (215.80)   | 1.06 (0.24) | 49.44 (242.64)   | 1.03 (0.21) |
-| 63        | 512×768 → 1080×1620 | 21         | 55.40 (241.79)   | 1.14 (0.26) | 56.70 (275.55)   | 1.11 (0.23) |
-| 75        | 512×768 → 1080×1620 | 25         | 62.60 (267.93)   | 1.20 (0.28) | 63.80 (308.51)   | 1.18 (0.24) |
-| 123       | 512×768 → 1080×1620 | 41         | 91.38 (373.60)   | 1.35 (0.33) | 92.90 (440.01)   | 1.32 (0.28) |
-| 243       | 512×768 → 1080×1620 | 81         | 164.25 (642.20)  | 1.48 (0.38) | 166.09 (780.20)  | 1.46 (0.31) |
-| 363       | 512×768 → 1080×1620 | 121        | 238.18 (913.61)  | 1.52 (0.40) | 239.80 (1114.32) | 1.51 (0.33) |
-| 453       | 512×768 → 1080×1620 | 151        | 296.52 (1132.01) | 1.53 (0.40) | 298.65 (1384.86) | 1.52 (0.33) |
-| 633       | 512×768 → 1080×1620 | 211        | 406.65 (1541.09) | 1.56 (0.41) | 409.44 (1887.62) | 1.55 (0.34) |
-| 903       | 512×768 → 1080×1620 | 301        | OOM (OOM)        | OOM (OOM)   | OOM (OOM)        | OOM (OOM)   |
-
-**NVIDIA RTX4090 24GB VRAM** (preserved_vram=off)
-| Model | Images | Resolution | Batch Size | Time (seconds) | FPS | Note |
-| ------------------------- | ------ | ------------------- | ---------- | -------------- | --- | --- |
-| 3B fp8 | 5 | 512x768 → 1080x1620 | 1 | 22.52 | 0.22 | |
-| 3B fp16 | 5 | 512x768 → 1080x1620 | 1 | 27.84 | 0.18 | |
-| 7B fp8 | 5 | 512x768 → 1080x1620 | 1 | 75.51 | 0.07 | |
-| 7B fp16 | 5 | 512x768 → 1080x1620 | 1 | 78.93 | 0.06 | |
-| 3B fp8 | 10 | 512x768 → 1080x1620 | 5 | 39.75 | 0.15 | preserve_memory=on|
-| 3B fp8 | 20 | 512x768 → 1080x1620 | 1 | 65.40 | 0.31 | |
-| 3B fp16 | 20 | 512x768 → 1080x1620 | 1 | 91.12 | 0.22 | |
-| 3B fp8 | 20 | 512x768 → 1280x1920 | 1 | 89.10 | 0.22 | |
-| 3B fp8 | 20 | 512x768 → 1480x2220 | 1 | 136.08| 0.15 | |
-| 3B fp8 | 20 | 512x768 → 1620x2430 | 1 | 191.28 | 0.10 | preserve_memory=on without GPU overload so longer 320sec |
-
-## Limitations
+## 📊 Benchmarks
+
+**7B models on NVIDIA H100 93GB VRAM** (values in parentheses are from the previous benchmark):
+
+| nb frames | Resolution          | Batch Size | execution time fp8 (s) | FPS fp8     | execution time fp16 (s) | FPS fp16           | perf progress since start |
+| --------- | ------------------- | ---------- | ---------------------- | ----------- | ----------------------- | ------------------ | ------------------------- |
+| 15        | 512×768 → 1080×1620 | 5          | 23.75 (26.71)          | 0.63 (0.56) | 24.23 (27.75)           | 0.61 (0.54) (0.10) | x6.1                      |
+| 27        | 512×768 → 1080×1620 | 9          | 27.75 (33.97)          | 0.97 (0.79) | 28.48 (35.08)           | 0.94 (0.77) (0.15) | x6.2                      |
+| 39        | 512×768 → 1080×1620 | 13         | 32.02 (41.01)          | 1.21 (0.95) | 32.62 (42.08)           | 1.19 (0.93) (0.19) | x6.2                      |
+| 51        | 512×768 → 1080×1620 | 17         | 36.39 (48.12)          | 1.40 (1.06) | 37.30 (49.44)           | 1.36 (1.03) (0.21) | x6.4                      |
+| 63        | 512×768 → 1080×1620 | 21         | 40.80 (55.40)          | 1.54 (1.14) | 41.32 (56.70)           | 1.52 (1.11) (0.23) | x6.6                      |
+| 75        | 512×768 → 1080×1620 | 25         | 45.37 (62.60)          | 1.65 (1.20) | 45.79 (63.80)           | 1.63 (1.18) (0.24) | x6.8                      |
+| 123       | 512×768 → 1080×1620 | 41         | 62.44 (91.38)          | 1.96 (1.35) | 62.28 (92.90)           | 1.97 (1.32) (0.28) | x7.0                      |
+| 243       | 512×768 → 1080×1620 | 81         | 106.13 (164.25)        | 2.28 (1.48) | 104.68 (166.09)         | 2.32 (1.46) (0.31) | x7.4                      |
+| 363       | 512×768 → 1080×1620 | 121        | 151.01 (238.18)        | 2.40 (1.52) | 148.67 (239.80)         | 2.44 (1.51) (0.33) | x7.4                      |
+| 453       | 512×768 → 1080×1620 | 151        | 186.98 (296.52)        | 2.42 (1.53) | 184.11 (298.65)         | 2.46 (1.52) (0.33) | x7.4                      |
+| 633       | 512×768 → 1080×1620 | 211        | 253.77 (406.65)        | 2.49 (1.56) | 249.43 (409.44)         | 2.53 (1.55) (0.34) | x7.4                      |
+| 903       | 512×768 → 1080×1620 | 301        | OOM (OOM)              | (OOM)       | OOM (OOM)               | (OOM) (OOM)        |                           |
+| 149       | 854x480 → 1920x1080 | 149        |                        |             | 450.22                  | 0.41               |                           |
+
+**3B FP8 models on NVIDIA H100 93GB VRAM** (values in parentheses are from the previous benchmark):
+
+| nb frames | Resolution          | Batch Size | execution time fp8 (s) | FPS fp8 | execution time fp16 (s) | FPS fp16 |
+| --------- | ------------------- | ---------- | ---------------------- | ------- | ----------------------- | -------- |
+| 149       | 854x480 → 1920x1080 | 149        | 361.22                 | 0.41    |                         |          |
+
+**NVIDIA RTX4090 24GB VRAM**
+
+| Model   | nb frames | Resolution          | Batch Size | execution time (seconds) | FPS         | Note                                     |
+| ------- | --------- | ------------------- | ---------- | ------------------------ | ----------- | ---------------------------------------- |
+| 3B fp8  | 5         | 512x768 → 1080x1620 | 1          | 14.66 (22.52)            | 0.34 (0.22) |                                          |
+| 3B fp16 | 5         | 512x768 → 1080x1620 | 1          | 17.02 (27.84)            | 0.29 (0.18) |                                          |
+| 7B fp8  | 5         | 512x768 → 1080x1620 | 1          | 46.23 (75.51)            | 0.11 (0.07) | preserve_memory=on                       |
+| 7B fp16 | 5         | 512x768 → 1080x1620 | 1          | 43.58 (78.93)            | 0.11 (0.06) | preserve_memory=on                       |
+| 3B fp8  | 10        | 512x768 → 1080x1620 | 5          | 39.75                    | 0.25        | preserve_memory=on                       |
+| 3B fp8  | 100       | 512x768 → 1080x1620 | 5          | 322.77                   | 0.31        | preserve_memory=on                       |
+| 3B fp8  | 1000      | 512x768 → 1080x1620 | 5          | 3624.08                  | 0.28        | preserve_memory=on                       |
+| 3B fp8  | 20        | 512x768 → 1080x1620 | 1          | 40.71 (65.40)            | 0.49 (0.31) |                                          |
+| 3B fp16 | 20        | 512x768 → 1080x1620 | 1          | 44.76 (91.12)            | 0.45 (0.22) |                                          |
+| 3B fp8  | 20        | 512x768 → 1280x1920 | 1          | 61.14 (89.10)            | 0.33 (0.22) |                                          |
+| 3B fp8  | 20        | 512x768 → 1480x2220 | 1          | 79.66 (136.08)           | 0.25 (0.15) |                                          |
+| 3B fp8  | 20        | 512x768 → 1620x2430 | 1          | 125.79 (191.28)          | 0.16 (0.10) | preserve_memory=off (preserve_memory=on) |
+| 3B fp8  | 149       | 854x480 → 1920x1080 | 5          | 782.76                   | 0.19        | preserve_memory=on                       |
+
+## ⚠️ Limitations
 
 - Use a lot of VRAM, it will take all!!
 - Processing speed depends on GPU capabilities
 
-## Credits
+## 🤝 Contributing
 
-- Original [SeedVR2](https://github.com/ByteDance-Seed/SeedVR) implementation
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
 
-# 📜 License
+Please make sure to update tests as appropriate.
 
-- The code in this repository is released under the MIT license as found in the [LICENSE file](LICENSE).
+### How to contribute:
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+### Development Setup:
+
+1. Clone the repository
+2. Install dependencies
+3. Make your changes
+4. Test your changes
+5. Submit a pull request
+
+### Code Style:
+
+- Follow the existing code style
+- Add comments for complex logic
+- Update documentation if needed
+- Ensure all tests pass
+
+### Reporting Issues:
 
+When reporting issues, please include:
 
+- Your system specifications
+- ComfyUI version
+- Python version
+- Error messages
+- Steps to reproduce the issue
 
+## 🙏 Credits
+
+- Original [SeedVR2](https://github.com/ByteDance-Seed/SeedVR) implementation
+
+# 📜 License
+
+- The code in this repository is released under the MIT license as found in the [LICENSE file](LICENSE).