Create README.md

README.md

@@ -0,0 +1,90 @@
+---
+library_name: diffusers
+license: apache-2.0
+language:
+- ja
+pipeline_tag: text-to-image
+tags:
+- stable-diffusion
+---
+# 🐟 Evo-Ukiyoe-v1
+
+🤗 [Models](https://huggingface.co/SakanaAI) | 📝 [Blog](TODO) | 🐦 [Twitter](https://twitter.com/SakanaAILabs)
+
+
+**EvoSDXL-JP-v1** is an experimental education-purpose Japanese SDXL Lightning. 
+This model was created using the Evolutionary Model Merge method. 
+Please refer to our [report](https://arxiv.org/abs/2403.13187) and [blog](https://sakana.ai/evosdxl-jp/) for more details. 
+This model was produced by merging the following models. 
+We are grateful to the developers of the source models.
+
+- [SDXL](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0)
+- [Juggernaut-XL-v9](https://huggingface.co/RunDiffusion/Juggernaut-XL-v9)
+- [SDXL-DPO](https://huggingface.co/mhdang/dpo-sdxl-text2image-v1)
+- [JSDXL](https://huggingface.co/stabilityai/japanese-stable-diffusion-xl)
+- [SDXL-Lightning](https://huggingface.co/ByteDance/SDXL-Lightning)
+
+
+## Usage
+
+Use the code below to get started with the model.
+
+
+<details>
+<summary> Click to expand </summary>
+
+1. Git clone this model card
+   ```
+   git clone https://huggingface.co/SakanaAI/EvoSDXL-JP-v1
+   ```
+2. Install packages
+   ```
+   cd EvoSDXL-JP-v1
+   pip install -r requirements.txt
+   ```
+3. Run
+   ```python
+   from evosdxl_jp_v1 import load_evosdxl_jp
+    
+   prompt = "柴犬"
+   pipe = load_evosdxl_jp(device="cuda")
+   images = pipe(prompt, num_inference_steps=4, guidance_scale=0).images
+   images[0].save("image.png")
+   ```
+
+</details>
+
+
+ 
+## Model Details
+
+<!-- Provide a longer summary of what this model is. -->
+
+- **Developed by:** [Sakana AI](https://sakana.ai/)
+- **Model type:** Diffusion-based text-to-image generative model
+- **Language(s):** Japanese
+- **Blog:** https://sakana.ai/TODO
+
+
+## License
+The Python script included in this repository is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+Please note that the license for the model/pipeline generated by this script is inherited from the source models.
+
+## Uses
+This model is provided for research and development purposes only and should be considered as an experimental prototype. 
+It is not intended for commercial use or deployment in mission-critical environments. 
+Use of this model is at the user's own risk, and its performance and outcomes are not guaranteed. 
+Sakana AI shall not be liable for any direct, indirect, special, incidental, or consequential damages, or any loss arising from the use of this model, regardless of the results obtained. 
+Users must fully understand the risks associated with the use of this model and use it at their own discretion.
+
+
+## Acknowledgement
+
+We would like to thank the developers of the source models for their contributions and for making their work available. 
+
+
+## Citation
+
+```bibtex
+TODO
+```