diff --git a/__init__.py b/__init__.py
index b752611..27eb812 100644
--- a/__init__.py
+++ b/__init__.py
@@ -75,7 +75,7 @@ NODE_CLASS_MAPPINGS = {
}
NODE_DISPLAY_NAME_MAPPINGS = {
- "RifeTensorrt": "Rife Tensorrt",
+ "RifeTensorrt": "⚡ Rife Tensorrt",
}
__all__ = ['NODE_CLASS_MAPPINGS', 'NODE_DISPLAY_NAME_MAPPINGS']
diff --git a/export_onnx.py b/export_onnx.py
index 8df1ffb..97f2948 100644
--- a/export_onnx.py
+++ b/export_onnx.py
@@ -139,4 +139,4 @@ def export_onnx(ckpt_name, ensemble, scale_factor):
print("=> sim ONNX Model check done!")
-export_onnx(ckpt_name="rife49.pth", ensemble=True, scale_factor=1)
\ No newline at end of file
+export_onnx(ckpt_name="rife47.pth", ensemble=True, scale_factor=1)
\ No newline at end of file
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..6e75fea
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,66 @@
+
+
+# ComfyUI Rife TensorRT ⚡
+
+[](https://www.python.org/downloads/release/python-31012/)
+[](https://developer.nvidia.com/cuda-downloads)
+[](https://developer.nvidia.com/tensorrt)
+[](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en)
+
+
+
+This project provides a [TensorRT](https://github.com/NVIDIA/TensorRT) implementation of [RIFE](https://github.com/hzwer/ECCV2022-RIFE) for ultra fast frame interpolation inside ComfyUI
+
+This project is licensed under [CC BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/), everyone is FREE to access, use, modify and redistribute with the same license.
+
+If you like the project, please give me a star! ⭐
+
+---
+
+
+
+## 🚀 Installation
+
+Navigate to the ComfyUI `/custom_nodes` directory
+
+```bash
+git clone https://github.com/yuvraj108c/ComfyUI-Rife-Tensorrt
+cd ./ComfyUI-Rife-Tensorrt
+pip install -r requirements.txt
+```
+
+## 🛠️ Building Tensorrt Engine
+
+1. Download one of the following onnx models:
+ - [rife49_ensemble_True_scale_1_sim.onnx](https://huggingface.co/yuvraj108c/rife-onnx/resolve/main/rife49_ensemble_True_scale_1_sim.onnx)
+ - [rife48_ensemble_True_scale_1_sim.onnx](https://huggingface.co/yuvraj108c/rife-onnx/resolve/main/rife48_ensemble_True_scale_1_sim.onnx)
+ - [rife47_ensemble_True_scale_1_sim.onnx](https://huggingface.co/yuvraj108c/rife-onnx/resolve/main/rife47_ensemble_True_scale_1_sim.onnx)
+2. Edit paths inside [export_trt.py](./export_trt.py) and build tensorrt engine by running:
+ - `python export_trt.py`
+
+3. Place the exported engine inside ComfyUI `/models/tensorrt/rife` directory
+
+## ☀️ Usage
+
+- Insert node by `Right Click -> tensorrt -> Rife Tensorrt`
+
+## 🤖 Environment tested
+
+- Ubuntu 22.04 LTS, Cuda 12.4, Tensorrt 10.4.0, Python 3.10, RTX 3070 GPU
+- Windows (Not tested, but should work)
+
+## 👏 Credits
+
+- https://github.com/styler00dollar/VSGAN-tensorrt-docker
+- https://github.com/Fannovel16/ComfyUI-Frame-Interpolation
+- https://github.com/hzwer/ECCV2022-RIFE
+
+## License
+
+[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/)