aliensmn commited on
Commit
21e26c8
Β·
verified Β·
1 Parent(s): dbca0cf

Add YAML metadata to fix model card warning

Browse files
Files changed (1) hide show
  1. README.md +35 -106
README.md CHANGED
@@ -1,122 +1,51 @@
1
- <div align="center">
2
-
3
- # ComfyUI Upscaler TensorRT ⚑
4
-
5
- [![python](https://img.shields.io/badge/python-3.10.12-green)](https://www.python.org/downloads/release/python-31012/)
6
- [![cuda](https://img.shields.io/badge/cuda-12.7-green)](https://developer.nvidia.com/cuda-downloads)
7
- [![trt](https://img.shields.io/badge/TRT-10.9-green)](https://developer.nvidia.com/tensorrt)
8
- [![by-nc-sa/4.0](https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-lightgrey)](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en)
9
-
10
- </div>
11
-
12
- This project provides a [Tensorrt](https://github.com/NVIDIA/TensorRT) implementation for fast image upscaling using models inside ComfyUI (2-4x faster)
13
-
14
- <p align="center">
15
- <img src="assets/node_v3.png" style="height: 400px" />
16
- </p>
17
-
18
- ## ⭐ Support
19
- If you like my projects and wish to see updates and new features, please consider supporting me. It helps a lot!
20
-
21
- [![ComfyUI-Depth-Anything-Tensorrt](https://img.shields.io/badge/ComfyUI--Depth--Anything--Tensorrt-blue?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Depth-Anything-Tensorrt)
22
- [![ComfyUI-Upscaler-Tensorrt](https://img.shields.io/badge/ComfyUI--Upscaler--Tensorrt-blue?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt)
23
- [![ComfyUI-Dwpose-Tensorrt](https://img.shields.io/badge/ComfyUI--Dwpose--Tensorrt-blue?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Dwpose-Tensorrt)
24
- [![ComfyUI-Rife-Tensorrt](https://img.shields.io/badge/ComfyUI--Rife--Tensorrt-blue?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Rife-Tensorrt)
25
-
26
- [![ComfyUI-Whisper](https://img.shields.io/badge/ComfyUI--Whisper-gray?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Whisper)
27
- [![ComfyUI_InvSR](https://img.shields.io/badge/ComfyUI__InvSR-gray?style=flat-square)](https://github.com/yuvraj108c/ComfyUI_InvSR)
28
- [![ComfyUI-Thera](https://img.shields.io/badge/ComfyUI--Thera-gray?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Thera)
29
- [![ComfyUI-Video-Depth-Anything](https://img.shields.io/badge/ComfyUI--Video--Depth--Anything-gray?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-Video-Depth-Anything)
30
- [![ComfyUI-PiperTTS](https://img.shields.io/badge/ComfyUI--PiperTTS-gray?style=flat-square)](https://github.com/yuvraj108c/ComfyUI-PiperTTS)
31
-
32
- [![buy-me-coffees](https://i.imgur.com/3MDbAtw.png)](https://www.buymeacoffee.com/yuvraj108cZ)
33
- [![paypal-donation](https://i.imgur.com/w5jjubk.png)](https://paypal.me/yuvraj108c)
34
  ---
35
 
36
- ## ⏱️ Performance
37
-
38
- _Note: The following results were benchmarked on FP16 engines inside ComfyUI, using 100 identical frames_
39
-
40
- | Device | Model | Input Resolution (WxH) | Output Resolution (WxH) | FPS |
41
- | :----: | :-----------: | :--------------------: | :---------------------: | :-: |
42
- | RTX5090 | 4x-UltraSharp | 512 x 512 | 2048 x 2048 | 12.7 |
43
- | RTX5090 | 4x-UltraSharp | 1280 x 1280 | 5120 x 5120 | 2.0 |
44
- | RTX4090 | 4x-UltraSharp | 512 x 512 | 2048 x 2048 | 6.7 |
45
- | RTX4090 | 4x-UltraSharp | 1280 x 1280 | 5120 x 5120 | 1.1 |
46
- | RTX3060 | 4x-UltraSharp | 512 x 512 | 2048 x 2048 | 2.2 |
47
- | RTX3060 | 4x-UltraSharp | 1280 x 1280 | 5120 x 5120 | 0.35 |
48
-
49
- ## πŸš€ Installation
50
- - Install via the manager
51
- - Or, navigate to the `/ComfyUI/custom_nodes` directory
52
-
53
- ```bash
54
- git clone https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt.git
55
- cd ./ComfyUI-Upscaler-Tensorrt
56
- pip install -r requirements.txt
57
- ```
58
-
59
- ## πŸ› οΈ Supported Models
60
-
61
- - These upscaler models have been tested to work with Tensorrt. Onnx are available [here](https://huggingface.co/yuvraj108c/ComfyUI-Upscaler-Onnx/tree/main)
62
- - The exported tensorrt models support dynamic image resolutions from 256x256 to 1280x1280 px (e.g 960x540, 512x512, 1280x720 etc).
63
 
64
- - [4x-AnimeSharp](https://openmodeldb.info/models/4x-AnimeSharp)
65
- - [4x-UltraSharp](https://openmodeldb.info/models/4x-UltraSharp)
66
- - [4x-WTP-UDS-Esrgan](https://openmodeldb.info/models/4x-WTP-UDS-Esrgan)
67
- - [4x_NMKD-Siax_200k](https://openmodeldb.info/models/4x-NMKD-Siax-CX)
68
- - [4x_RealisticRescaler_100000_G](https://openmodeldb.info/models/4x-RealisticRescaler)
69
- - [4x_foolhardy_Remacri](https://openmodeldb.info/models/4x-Remacri)
70
- - [RealESRGAN_x4](https://openmodeldb.info/models/4x-realesrgan-x4plus)
71
- - [4xNomos2_otf_esrgan](https://openmodeldb.info/models/4x-Nomos2-otf-esrgan)
72
- - [4x-ClearRealityV1](https://openmodeldb.info/models/4x-ClearRealityV1)
73
- - [4x_UniversalUpscalerV2-Neutral_115000_swaG](https://openmodeldb.info/models/4x-UniversalUpscalerV2-Neutral)
74
- - [4x-UltraSharpV2_Lite](https://huggingface.co/Kim2091/UltraSharpV2)
75
 
76
- ## β˜€οΈ Usage
77
 
78
- - Load [example workflow](assets/tensorrt_upscaling_workflow.json)
79
- - Choose the appropriate model from the dropdown
80
- - The tensorrt engine will be built automatically
81
- - Load an image of resolution between 256-1280px
82
- - Set `resize_to` to resize the upscaled images to fixed resolutions
83
 
84
- ## πŸ”§ Custom Models
85
- - To export other ESRGAN models, you'll have to build the onnx model first, using [export_onnx.py](scripts/export_onnx.py)
86
- - Place the onnx model in `/ComfyUI/models/onnx/YOUR_MODEL.onnx`
87
- - Then, add your model to this list [load_upscaler_config.json](load_upscaler_config.json)
88
- - Finally, run the same workflow and choose your model
89
- - If you've tested another working tensorrt model, let me know to add it officially to this node
90
 
91
- ## 🚨 Updates
92
- ### 27 Auguest 2025
93
- - Support 4x-UltraSharpV2_Lite, 4x_UniversalUpscalerV2-Neutral_115000_swaG, 4x-ClearRealityV1
94
- - Load models from config [PR#57](https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt/pull/57)
95
 
96
- ### 30 April 2025
97
- - Merge https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt/pull/48 by @BiiirdPrograms to fix soft-lock by raising an error when input image dimensions unsupported
98
- ### 4 March 2025 (breaking)
99
- - Automatic tensorrt engines are built from the workflow itself, to simplify the process for non-technical people
100
- - Separate model loading and tensorrt processing into different nodes
101
- - Optimise post processing
102
- - Update onnx export script
103
 
104
- ## ⚠️ Known issues
105
 
106
- - If you upgrade tensorrt version, you'll have to rebuild the engines
107
- - Only models with ESRGAN architecture are currently working
108
- - High ram usage when exporting `.pth` to `.onnx`
 
 
 
109
 
110
- ## πŸ€– Environment tested
111
 
112
- - Ubuntu 22.04 LTS, Cuda 12.4, Tensorrt 10.8, Python 3.10, H100 GPU
113
- - Windows 11
114
 
115
- ## πŸ‘ Credits
116
 
117
- - [NVIDIA/Stable-Diffusion-WebUI-TensorRT](https://github.com/NVIDIA/Stable-Diffusion-WebUI-TensorRT)
118
- - [comfyanonymous/ComfyUI](https://github.com/comfyanonymous/ComfyUI)
119
 
120
- ## License
 
 
121
 
122
- [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
 
1
+ ---
2
+ license: mit
3
+ tags:
4
+ - comfyui
5
+ - comfyui-custom-nodes
6
+ - mirror
7
+ - github-mirror
8
+ library_name: comfyui
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  ---
10
 
11
+ # ComfyUI-Upscaler-Tensorrt
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
+ πŸ”„ **Mirror of GitHub Repository**
 
 
 
 
 
 
 
 
 
 
14
 
15
+ This is a personal mirror of the original GitHub repository for easy access and backup.
16
 
17
+ ## πŸ“¦ Original Source
 
 
 
 
18
 
19
+ **GitHub:** [https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt](https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt)
 
 
 
 
 
20
 
21
+ ## 🎯 Purpose
 
 
 
22
 
23
+ This mirror is maintained for:
24
+ - βœ… Easy access and backup
25
+ - βœ… Integration with Hugging Face workflows
26
+ - βœ… Personal development and testing
27
+ - βœ… Offline availability
 
 
28
 
29
+ ## πŸ“– Usage
30
 
31
+ Please refer to the original GitHub repository for:
32
+ - Latest updates and releases
33
+ - Installation instructions
34
+ - Documentation
35
+ - Issues and support
36
+ - Contributing guidelines
37
 
38
+ ## πŸ™ Attribution
39
 
40
+ All code and content in this repository belongs to the original authors and contributors.
41
+ This is purely a mirror for personal convenience.
42
 
43
+ **Please support the original project:** https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt
44
 
45
+ ---
 
46
 
47
+ **Mirrored by:** aliensmn
48
+ **Mirror Type:** ComfyUI Custom Node
49
+ **Original Repository:** https://github.com/yuvraj108c/ComfyUI-Upscaler-Tensorrt
50
 
51
+ *If you are the original author and would like this mirror removed, please contact me.*