Update README.md

README.md

@@ -1,3 +1,37 @@
----
-license: apache-2.0
----
+---
+base_model:
+- MAGREF-Video/MAGREF
+base_model_relation: quantized
+library_name: gguf
+tags:
+- image-to-video
+- quantized
+language:
+- en
+license: apache-2.0
+---
+
+This is a GGUF conversion of [MAGREF-Video/MAGREF](https://huggingface.co/MAGREF-Video/MAGREF).
+
+All quantized versions were created from the base FP16 model using the conversion scripts provided by city96, available at the [ComfyUI-GGUF](https://github.com/city96/ComfyUI-GGUF/tree/main/tools) GitHub repository. 
+
+## Usage
+
+The model files can be used in [ComfyUI](https://github.com/comfyanonymous/ComfyUI/) with the [ComfyUI-GGUF](https://github.com/city96/ComfyUI-GGUF) custom node. Place the required model(s) in the following folders:
+
+| Type         | Name                                | Location                       | Download         |
+| ------------ | ----------------------------------- | ------------------------------ | ---------------- |
+| Main Model   | lym00/MAGREF_Wan2.1_I2V_14B-GGUF    | `ComfyUI/models/unet`          | GGUF (this repo) |
+| Text Encoder | umt5-xxl-encoder                    | `ComfyUI/models/text_encoders` | [Safetensors](https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/tree/main/split_files/text_encoders) / [GGUF](https://huggingface.co/city96/umt5-xxl-encoder-gguf/tree/main) |
+| CLIP Vision  | clip_vision_h                       | `ComfyUI/models/clip_vision`   | [Safetensors](https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/blob/main/split_files/clip_vision/clip_vision_h.safetensors) |
+| VAE          | Wan2_1_VAE_bf16                     | `ComfyUI/models/vae`           | [Safetensors](https://huggingface.co/Kijai/WanVideo_comfy/blob/main/Wan2_1_VAE_bf16.safetensors) |
+
+[**ComfyUI example workflow**](https://huggingface.co/lym00/MAGREF_Wan2.1_I2V_14B-GGUF/blob/main/Magref_example_workflow.json)
+
+### Notes
+
+*All original licenses and restrictions from the base models still apply.*
+
+ ## Reference
+
+- For an overview of quantization types, please see the [GGUF quantization types](https://huggingface.co/docs/hub/gguf#quantization-types).