aliensmn commited on
Commit
ce264c0
·
verified ·
1 Parent(s): 8c73379

Add YAML metadata to fix model card warning

Browse files
Files changed (1) hide show
  1. README.md +36 -179
README.md CHANGED
@@ -1,194 +1,51 @@
1
- # ComfyUI Frame Interpolation (ComfyUI VFI) (WIP)
 
 
 
 
 
 
 
 
2
 
3
- A custom node set for Video Frame Interpolation in ComfyUI.
4
- **UPDATE** Memory management is improved. Now this extension takes less RAM and VRAM than before.
5
 
6
- **UPDATE 2** VFI nodes now accept scheduling multipiler values
7
 
8
- ![](./interpolation_schedule.png)
9
- ![](./test_vfi_schedule.gif)
10
 
11
- ## Nodes
12
- * KSampler Gradually Adding More Denoise (efficient)
13
- * GMFSS Fortuna VFI
14
- * IFRNet VFI
15
- * IFUnet VFI
16
- * M2M VFI
17
- * RIFE VFI (4.0 - 4.9) (Note that option `fast_mode` won't do anything from v4.5+ as `contextnet` is removed)
18
- * FILM VFI
19
- * Sepconv VFI
20
- * AMT VFI
21
- * Make Interpolation State List
22
- * STMFNet VFI (requires at least 4 frames, can only do 2x interpolation for now)
23
- * FLAVR VFI (same conditions as STMFNet)
24
 
25
- ## Install
26
- ### ComfyUI Manager
27
- Incompatibile issue with it is now fixed
28
 
29
- Following this guide to install this extension
30
 
31
- https://github.com/ltdrdata/ComfyUI-Manager#how-to-use
32
- ### Command-line
33
- #### Windows
34
- Run install.bat
 
35
 
36
- For Window users, if you are having trouble with cupy, please run `install.bat` instead of `install-cupy.py` or `python install.py`.
37
- #### Linux
38
- Open your shell app and start venv if it is used for ComfyUI. Run:
39
- ```
40
- python install.py
41
- ```
42
- ## Support for non-CUDA device (experimental)
43
- If you don't have a NVidia card, you can try `taichi` ops backend powered by [Taichi Lang](https://www.taichi-lang.org/)
44
 
45
- On Windows, you can install it by running `install.bat` or `pip install taichi` on Linux
 
 
 
 
 
46
 
47
- Then change value of `ops_backend` from `cupy` to `taichi` in `config.yaml`
48
 
49
- If `NotImplementedError` appears, a VFI node in the workflow isn't supported by taichi
 
50
 
51
- ## Usage
52
- All VFI nodes can be accessed in **category** `ComfyUI-Frame-Interpolation/VFI` if the installation is successful and require a `IMAGE` containing frames (at least 2, or at least 4 for STMF-Net/FLAVR).
53
 
54
- Regarding STMFNet and FLAVR, if you only have two or three frames, you should use: Load Images -> Other VFI node (FILM is recommended in this case) with `multiplier=4` -> STMFNet VFI/FLAVR VFI
55
 
56
- `clear_cache_after_n_frames` is used to avoid out-of-memory. Decreasing it makes the chance lower but also increases processing time.
 
 
57
 
58
- It is recommended to use LoadImages (LoadImagesFromDirectory) from [ComfyUI-Advanced-ControlNet](https://github.com/Kosinkadink/ComfyUI-Advanced-ControlNet/) and [ComfyUI-VideoHelperSuite](https://github.com/Kosinkadink/ComfyUI-VideoHelperSuite) along side with this extension.
59
-
60
- ## Example
61
- ### Simple workflow
62
- Workflow metadata isn't embeded
63
- Download these two images [anime0.png](./demo_frames/anime0.png) and [anime1.png](./demo_frames/anime0.png) and put them into a folder like `E:\test` in this image.
64
- ![](./example.png)
65
-
66
- ### Complex workflow
67
- It's used in AnimationDiff (can load workflow metadata)
68
- ![](All_in_one_v1_3.png)
69
-
70
- ## Credit
71
- Big thanks for styler00dollar for making [VSGAN-tensorrt-docker](https://github.com/styler00dollar/VSGAN-tensorrt-docker). About 99% the code of this repo comes from it.
72
-
73
- Citation for each VFI node:
74
- ### GMFSS Fortuna
75
- The All-In-One GMFSS: Dedicated for Anime Video Frame Interpolation
76
-
77
- https://github.com/98mxr/GMFSS_Fortuna
78
-
79
- ### IFRNet
80
- ```bibtex
81
- @InProceedings{Kong_2022_CVPR,
82
- author = {Kong, Lingtong and Jiang, Boyuan and Luo, Donghao and Chu, Wenqing and Huang, Xiaoming and Tai, Ying and Wang, Chengjie and Yang, Jie},
83
- title = {IFRNet: Intermediate Feature Refine Network for Efficient Frame Interpolation},
84
- booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR)},
85
- year = {2022}
86
- }
87
- ```
88
-
89
- ### IFUnet
90
- RIFE with IFUNet, FusionNet and RefineNet
91
-
92
- https://github.com/98mxr/IFUNet
93
- ### M2M
94
- ```bibtex
95
- @InProceedings{hu2022m2m,
96
- title={Many-to-many Splatting for Efficient Video Frame Interpolation},
97
- author={Hu, Ping and Niklaus, Simon and Sclaroff, Stan and Saenko, Kate},
98
- journal={CVPR},
99
- year={2022}
100
- }
101
- ```
102
-
103
- ### RIFE
104
- ```bibtex
105
- @inproceedings{huang2022rife,
106
- title={Real-Time Intermediate Flow Estimation for Video Frame Interpolation},
107
- author={Huang, Zhewei and Zhang, Tianyuan and Heng, Wen and Shi, Boxin and Zhou, Shuchang},
108
- booktitle={Proceedings of the European Conference on Computer Vision (ECCV)},
109
- year={2022}
110
- }
111
- ```
112
-
113
- ### FILM
114
- [Frame interpolation in PyTorch](https://github.com/dajes/frame-interpolation-pytorch)
115
-
116
- ```bibtex
117
- @inproceedings{reda2022film,
118
- title = {FILM: Frame Interpolation for Large Motion},
119
- author = {Fitsum Reda and Janne Kontkanen and Eric Tabellion and Deqing Sun and Caroline Pantofaru and Brian Curless},
120
- booktitle = {European Conference on Computer Vision (ECCV)},
121
- year = {2022}
122
- }
123
- ```
124
-
125
- ```bibtex
126
- @misc{film-tf,
127
- title = {Tensorflow 2 Implementation of "FILM: Frame Interpolation for Large Motion"},
128
- author = {Fitsum Reda and Janne Kontkanen and Eric Tabellion and Deqing Sun and Caroline Pantofaru and Brian Curless},
129
- year = {2022},
130
- publisher = {GitHub},
131
- journal = {GitHub repository},
132
- howpublished = {\url{https://github.com/google-research/frame-interpolation}}
133
- }
134
- ```
135
-
136
- ### Sepconv
137
- ```bibtex
138
- [1] @inproceedings{Niklaus_WACV_2021,
139
- author = {Simon Niklaus and Long Mai and Oliver Wang},
140
- title = {Revisiting Adaptive Convolutions for Video Frame Interpolation},
141
- booktitle = {IEEE Winter Conference on Applications of Computer Vision},
142
- year = {2021}
143
- }
144
- ```
145
-
146
- ```bibtex
147
- [2] @inproceedings{Niklaus_ICCV_2017,
148
- author = {Simon Niklaus and Long Mai and Feng Liu},
149
- title = {Video Frame Interpolation via Adaptive Separable Convolution},
150
- booktitle = {IEEE International Conference on Computer Vision},
151
- year = {2017}
152
- }
153
- ```
154
-
155
- ```bibtex
156
- [3] @inproceedings{Niklaus_CVPR_2017,
157
- author = {Simon Niklaus and Long Mai and Feng Liu},
158
- title = {Video Frame Interpolation via Adaptive Convolution},
159
- booktitle = {IEEE Conference on Computer Vision and Pattern Recognition},
160
- year = {2017}
161
- }
162
- ```
163
-
164
- ### AMT
165
- ```bibtex
166
- @inproceedings{licvpr23amt,
167
- title={AMT: All-Pairs Multi-Field Transforms for Efficient Frame Interpolation},
168
- author={Li, Zhen and Zhu, Zuo-Liang and Han, Ling-Hao and Hou, Qibin and Guo, Chun-Le and Cheng, Ming-Ming},
169
- booktitle={IEEE Conference on Computer Vision and Pattern Recognition (CVPR)},
170
- year={2023}
171
- }
172
- ```
173
-
174
- ### ST-MFNet
175
- ```bibtex
176
- @InProceedings{Danier_2022_CVPR,
177
- author = {Danier, Duolikun and Zhang, Fan and Bull, David},
178
- title = {ST-MFNet: A Spatio-Temporal Multi-Flow Network for Frame Interpolation},
179
- booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR)},
180
- month = {June},
181
- year = {2022},
182
- pages = {3521-3531}
183
- }
184
- ```
185
-
186
- ### FLAVR
187
- ```bibtex
188
- @article{kalluri2021flavr,
189
- title={FLAVR: Flow-Agnostic Video Representations for Fast Frame Interpolation},
190
- author={Kalluri, Tarun and Pathak, Deepak and Chandraker, Manmohan and Tran, Du},
191
- booktitle={arxiv},
192
- year={2021}
193
- }
194
- ```
 
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-Frame-Interpolation
 
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/Fannovel16/ComfyUI-Frame-Interpolation](https://github.com/Fannovel16/ComfyUI-Frame-Interpolation)
 
 
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/Fannovel16/ComfyUI-Frame-Interpolation
 
44
 
45
+ ---
46
 
47
+ **Mirrored by:** aliensmn
48
+ **Mirror Type:** ComfyUI Custom Node
49
+ **Original Repository:** https://github.com/Fannovel16/ComfyUI-Frame-Interpolation
50
 
51
+ *If you are the original author and would like this mirror removed, please contact me.*