SakanaAI
/

EvoSDXL-JP-v1

Text-to-Image

Diffusers

Japanese

stable-diffusion

Model card Files Files and versions Community

mkshing commited on Apr 16, 2024

Commit

4009728

verified ·

1 Parent(s): 86e46f8

Update README.md

Browse files

Files changed (1) hide show

README.md +58 -172

README.md CHANGED Viewed

@@ -1,200 +1,86 @@
 ---
 library_name: diffusers
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🧨 diffusers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
 Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: diffusers
+license: apache-2.0
+language:
+- ja
+pipeline_tag: text-to-image
+tags:
+- stable-diffusion
 ---
+# 🐟 EvoSDXL-JP-v1
+🤗 [Models](https://huggingface.co/SakanaAI) | 📚 [Paper](https://arxiv.org/abs/2403.13187) | 📝 [Blog](https://sakana.ai/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/TODO) 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>
+```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
+- **License:** [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+- **Repository:** [SakanaAI/evolutionary-model-merge](https://github.com/SakanaAI/evolutionary-model-merge)
+- **Paper:** https://arxiv.org/abs/2403.13187
+- **Blog:** https://sakana.ai/TODO
+## 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
+@misc{akiba2024evomodelmerge,
+      title         = {Evolutionary Optimization of Model Merging Recipes},
+      author.       = {Takuya Akiba and Makoto Shing and Yujin Tang and Qi Sun and David Ha},
+      year          = {2024},
+      eprint        = {2403.13187},
+      archivePrefix = {arXiv},
+      primaryClass  = {cs.NE}
+}
+```