Update README.md
#1
by
ayoubkirouane
- opened
README.md
CHANGED
@@ -3,6 +3,91 @@ license: creativeml-openrail-m
|
|
3 |
tags:
|
4 |
- text-to-image
|
5 |
- stable-diffusion
|
|
|
|
|
|
|
|
|
6 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7 |
|
8 |
|
|
|
3 |
tags:
|
4 |
- text-to-image
|
5 |
- stable-diffusion
|
6 |
+
language:
|
7 |
+
- en
|
8 |
+
library_name: diffusers
|
9 |
+
pipeline_tag: text-to-image
|
10 |
---
|
11 |
+
# Model Card: Stable-Cats-Generator
|
12 |
+
|
13 |
+
## Model Information
|
14 |
+
|
15 |
+
- **Model Name:** Stable-Cats-Generator
|
16 |
+
- **Model Version:** v1
|
17 |
+
- **Model Type:** Image Generation
|
18 |
+
- **Based on:** Stable Diffusion v2
|
19 |
+
|
20 |
+
## Model Description
|
21 |
+
|
22 |
+
Stable-Cats-Generator is an image generation model fine-tuned for generating white cat images based on text prompts. It is built upon Stable Diffusion v2 and utilizes a pretrained text encoder (OpenCLIP-ViT/H) for text-to-image generation.
|
23 |
+
|
24 |
+
|
25 |
+
![image/png](https://cdn-uploads.huggingface.co/production/uploads/6338c06c107c4835a05699f9/Lxu-YADfOSpXUFTFsOxuA.png)
|
26 |
+
|
27 |
+
## Intended Use
|
28 |
+
|
29 |
+
- Safe content generation
|
30 |
+
- Artistic and creative processes
|
31 |
+
- Bias and limitation exploration
|
32 |
+
- Educational and creative tools
|
33 |
+
|
34 |
+
## Potential Use Cases
|
35 |
+
|
36 |
+
- Generating cat images for artistic purposes
|
37 |
+
- Investigating biases and limitations of generative models
|
38 |
+
- Creating safe and customizable content
|
39 |
+
- Enhancing educational or creative tools
|
40 |
+
|
41 |
+
## Model Capabilities
|
42 |
+
|
43 |
+
- High-quality white cat image generation
|
44 |
+
- Quick image generation, even on single GPUs
|
45 |
+
- Customizable for specific needs and datasets
|
46 |
+
|
47 |
+
## Limitations
|
48 |
+
|
49 |
+
- May not always produce realistic images
|
50 |
+
- Limited to generating white cat images based on text prompts
|
51 |
+
- Ethical considerations when using generated content
|
52 |
+
|
53 |
+
## Ethical Considerations
|
54 |
+
|
55 |
+
- Ensure generated content is safe and non-harmful
|
56 |
+
- Monitor and mitigate potential biases in generated content
|
57 |
+
- Respect copyright and licensing when using generated images
|
58 |
+
|
59 |
+
## Responsible AI
|
60 |
+
|
61 |
+
- Ongoing monitoring and evaluation of model outputs
|
62 |
+
- Regular updates to address limitations and improve safety
|
63 |
+
- Compliance with ethical guidelines and legal regulations
|
64 |
+
|
65 |
+
## Disclaimer
|
66 |
+
|
67 |
+
This model card serves as a documentation tool and does not constitute legal or ethical guidance. Users of the model are responsible for adhering to ethical and legal standards in their use of the model.
|
68 |
+
|
69 |
+
## Usage
|
70 |
+
|
71 |
+
```
|
72 |
+
pip install diffusers==0.11.1
|
73 |
+
pip install transformers scipy ftfy accelerate
|
74 |
+
```
|
75 |
+
|
76 |
+
```python
|
77 |
+
|
78 |
+
import torch
|
79 |
+
from diffusers import StableDiffusionPipeline
|
80 |
+
pipe = StableDiffusionPipeline.from_pretrained("ayoubkirouane/Stable-Cats-Generator", torch_dtype=torch.float16)
|
81 |
+
pipe = pipe.to("cuda")
|
82 |
+
prompt = "A photo of a picture-perfect white cat."
|
83 |
+
image = pipe(prompt).images[0] # image here is in [PIL format](https://pillow.readthedocs.io/en/stable/)
|
84 |
+
|
85 |
+
# Now to display an image you can either save it such as:
|
86 |
+
image.save(f"cat.png")
|
87 |
+
|
88 |
+
# or if you're in a google colab you can directly display it with
|
89 |
+
image
|
90 |
+
|
91 |
+
```
|
92 |
|
93 |
|