Update README.md

README.md

@@ -16,33 +16,50 @@ language:
 pipeline_tag: text-to-image
 ---
 
-<!-- This model card has been generated automatically according to the information the training script had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
-
 # LoRA text2image fine-tuning - sylvainlapeyrade/kanji2english
-These are LoRA adaption weights for CompVis/stable-diffusion-v1-4. The weights were fine-tuned on the sylvainlapeyrade/kanji_english_meaning dataset. You can find some example images in the following. 
+<i>This is a model ran on only one epoch on Google Colab free version for proof of concepts purpose. Do not expect extraordinary resutls.</i>
 
-![img_0](./image_0.png)
-![img_1](./image_1.png)
-![img_2](./image_2.png)
-![img_3](./image_3.png)
+These are LoRA adaptation weights for CompVis/stable-diffusion-v1-4. The weights were fine-tuned on the sylvainlapeyrade/kanji_english_meaning dataset to generate Kanji images based on English descriptions. This model provides a novel approach to visualizing the artistic representation of Kanji characters through a text-to-image generation process, using the powerful Stable Diffusion architecture enhanced with LoRA layers for fine-tuning.
+
+## Model Description
 
+This model uses LoRA (Low-Rank Adaptation) layers to fine-tune the Stable Diffusion v1-4 model specifically for the task of generating Kanji images from English text descriptions. The fine-tuning process was conducted using the sylvainlapeyrade/kanji_english_meaning dataset, which contains a collection of Kanji characters and their corresponding English meanings.
 
-<!--
-## Intended uses & limitations
+## How to Use
 
-#### How to use
+This model is intended to be used with the `diffusers` library. Here is an example of how to generate an image from text:
 
 ```python
-# TODO: add an example code snippet for running this diffusion pipeline
+from diffusers import LoraDiffusionPipeline
+
+# Load the pipeline
+pipe = LoraDiffusionPipeline.from_pretrained("sylvainlapeyrade/kanji2english")
+
+# Generate an image
+prompt = "a kanji meaning a Doge"
+image = pipe(prompt).images[0]
+
+# Save or display the image
+image.save("kanji_doge.png")
 ```
 
-#### Limitations and bias
+## Limitations and Bias
+
+This model has been trained specifically for generating Kanji characters from English text inputs with the <i>"a kanji meaning"</i> sequence and may not generalize well to other text-to-image tasks outside this scope. Additionally, the accuracy of the generated images may vary depending on the complexity and rarity of the Kanji.
+
+## Examples
+
+Below are some example images generated by the model:
+
+![img_0](./image_0.png)
+![img_1](./image_1.png)
+![img_2](./image_2.png)
+![img_3](./image_3.png)
+
+## Acknowledgements
 
-[TODO: provide examples of latent issues and potential remediations]
+Special thanks to the creators of the KANJIDIC and KanjiVG projects for providing the data sources used during training.
 
-## Training details
+## License
 
-[TODO: describe the data used to train the model]
--->
+This model is released under the CreativeML Open RAIL-M license, which allows for non-commercial use, sharing, and adaptation with attribution.