ayoubkirouane commited on
Commit
da07b0e
1 Parent(s): 11abd36

Update README.md

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