Create README.md

README.md

@@ -0,0 +1,33 @@
+---
+license: creativeml-openrail-m
+datasets:
+- osunlp/MagicBrush
+---
+
+# InstructPix2Pix checkpoint fine-tuned on [MagicBrush](https://osu-nlp-group.github.io/MagicBrush/). 
+
+## 1. Env Setup
+
+To use the HIVE checkpoint fine-tuned on MagicBrush, set up env with following the original HIVE:
+
+Download this checkpoint into `checkpoints` folder via
+
+```shell
+cd checkpoints
+# recent best checkpoint:
+wget https://huggingface.co/osunlp/HIVE-MagicBrush/resolve/main/MagicBrush-epoch-000130.ckpt
+
+```
+
+## Citation
+
+If you find this checkpoint useful, please consider citing our paper:
+
+```
+@inproceedings{Zhang2023MagicBrush,
+        title={MagicBrush: A Manually Annotated Dataset for Instruction-Guided Image Editing},
+        author={Kai Zhang and Lingbo Mo and Wenhu Chen and Huan Sun and Yu Su},
+        booktitle={Advances in Neural Information Processing Systems},
+        year={2023}
+}
+```