theantiquepiece commited on
Commit
7676785
1 Parent(s): 4d113d9

Upload folder using huggingface_hub

Browse files
LICENSE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
README.md ADDED
@@ -0,0 +1,174 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: Stable Diffusion Model
3
+ description: Text-to-image generative model using PyTorch and Hugging Face Diffusers
4
+ version: 1.0.0
5
+ license: apache-2.0
6
+ authors:
7
+ - name: Maneesh Singh
8
+ url: https://github.com/Maneesh-Singh123
9
+ tags:
10
+ - text-to-image
11
+ - generative-model
12
+ - stable-diffusion
13
+ - pytorch
14
+ - hugging-face
15
+ - diffusers
16
+ model-type: latent-diffusion
17
+ task: image-generation
18
+ dataset: various
19
+ metrics:
20
+ - psnr
21
+ - ssim
22
+ - frechet-inception-distance
23
+ parameters:
24
+ - learning-rate: 5e-5
25
+ - batch-size: 8
26
+ - num-epochs: 10
27
+ - num-inference-steps: 50
28
+ ---
29
+
30
+
31
+ # Stable Diffusion Model - PyTorch & Hugging Face Diffusers
32
+
33
+ This repository contains the implementation of the **Stable Diffusion** model using **PyTorch** and **Hugging Face Diffusers**. Stable Diffusion is a text-to-image generative model that leverages a diffusion process to generate high-quality, detailed images from textual descriptions.
34
+
35
+ ## Table of Contents
36
+ - [Installation](#installation)
37
+ - [Usage](#usage)
38
+ - [Model Overview](#model-overview)
39
+ - [Training](#training)
40
+ - [Inference](#inference)
41
+ - [Examples](#examples)
42
+ - [Acknowledgments](#acknowledgments)
43
+
44
+ ## Installation
45
+
46
+ To get started, you'll need to clone this repository and install the required dependencies. We recommend using a virtual environment to avoid conflicts.
47
+
48
+ ```bash
49
+ git clone https://github.com/the-antique-piece/stable_diffusion.git
50
+ cd stable_diffusion
51
+
52
+ # Create and activate a virtual environment (optional)
53
+ python -m venv venv
54
+ source venv/bin/activate # On Windows use `venv\Scripts\activate`
55
+
56
+ # Install required dependencies
57
+ pip install -r requirements.txt
58
+ ```
59
+
60
+ ### Requirements
61
+
62
+ - Python 3.8+
63
+ - PyTorch
64
+ - Hugging Face Diffusers
65
+ - Transformers
66
+ - Datasets
67
+ - PIL
68
+
69
+ To install all dependencies manually, you can run:
70
+
71
+ ```bash
72
+ pip install torch diffusers transformers datasets pillow flax
73
+ ```
74
+
75
+ ## Model Overview
76
+
77
+ Stable Diffusion is a **latent diffusion model** that is trained to denoise a latent representation of the image, conditioned on a text prompt. It operates by gradually reversing a noise process applied to the data during training, allowing it to generate images starting from pure noise.
78
+
79
+ This repository implements the following features:
80
+ - **Text-to-image generation**: Generate images based on a text prompt.
81
+ - **Fine-tuning**: Customize the model for specific datasets.
82
+ - **Inference**: Run the model on pre-trained weights for fast image generation.
83
+
84
+ ### Model Architecture
85
+
86
+ The Stable Diffusion model consists of:
87
+ 1. **Variational Autoencoder (VAE)** - Encodes images into latent space.
88
+ 2. **U-Net** - A denoising network that learns to reverse the noise process.
89
+ 3. **Text Encoder** - Encodes text prompts into latent space to guide image generation.
90
+
91
+ ## Usage
92
+
93
+ ### Text-to-Image Generation
94
+
95
+ Once the environment is set up, you can generate images from text prompts as follows:
96
+
97
+ ```python
98
+ from diffusers import DiffusionPipeline
99
+ import torch
100
+
101
+ # Remove torch_dtype=torch.float16
102
+ pipeline = DiffusionPipeline.from_pretrained("stable-diffusion/stable-diffusion-v1")
103
+
104
+ # Use a Nvidia GPU if available, or else cpu
105
+ device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
106
+ pipeline.to(device)
107
+
108
+ pipeline("An image of futuristic city where everyting is perfect").images[0]
109
+ ```
110
+ ### To get more control over image generation create seperate python file and paste this code and run it from virtual environment using 'python python_script.py'
111
+ **If You don't running this model on nvidia GPU change torch_type=torch.float32**
112
+
113
+ ```python
114
+ from diffusers import DiffusionPipeline
115
+ import torch
116
+ # Provide a path to directory where the model_index.json is placed
117
+ weights_path = "directory_path_to_model_index.json"
118
+ pipeline = DiffusionPipeline.from_pretrained(weights_path, torch_dtype=torch.float16)
119
+ # You can change prompt to get different photos, increase inference_steps's value to get high quality images
120
+ prompt = 'a cat sitting on a windowsill, looking at the sunset'
121
+ height, width = 512, 512
122
+ num_inference_steps = 50
123
+
124
+ image = pipeline(prompt, height=height, width=width, num_inference_steps=num_inference_steps).images[0]
125
+ image.save("myimage.png")
126
+ ```
127
+ ### Custom Model Weights
128
+
129
+ If you have custom model weights, load them into the pipeline:
130
+
131
+ ```python
132
+ pipe = StableDiffusionPipeline.from_pretrained("path/to/your/model").to("cuda")
133
+ ```
134
+
135
+ ## Training
136
+
137
+ This repository also supports fine-tuning the Stable Diffusion model on your own dataset. To prepare for training:
138
+
139
+ 1. **Prepare Dataset**: Ensure that your dataset is in a format compatible with Hugging Face's `datasets` library.
140
+ 2. **Configure Training Parameters**: Adjust hyperparameters such as learning rate, batch size, and number of epochs.
141
+
142
+ ### Fine-tuning Example
143
+
144
+ ```bash
145
+ python train.py --dataset_path /path/to/dataset --output_dir /path/to/output --batch_size 8 --learning_rate 5e-5 --num_epochs 10
146
+ ```
147
+
148
+ Training can be done with the `train.py` script, which supports distributed training for large datasets and multiple GPUs.
149
+
150
+ ## Inference
151
+
152
+ To run inference on a trained model, use the `inference.py` script:
153
+
154
+ ```bash
155
+ python inference.py --model_path /path/to/trained/model --prompt "a futuristic city skyline at sunset"
156
+ ```
157
+
158
+ ## Examples
159
+
160
+ Here are some example prompts and the corresponding generated images:
161
+
162
+ - **Prompt**: "a cat sitting on a windowsill, looking at the sunset"
163
+ ![Example Image 1](generated_images/image8.png)
164
+
165
+ - **Prompt**: "a futuristic cityscape with flying cars"
166
+ ![Example Image 2](generated_images/image7.png)
167
+
168
+ ## Acknowledgments
169
+
170
+ This implementation is based on the **Stable Diffusion** model by [Huggingface](https://github.com/huggingface/diffusers.git) and utilizes the Huggingface **Diffusers** library.
171
+
172
+ ## License
173
+
174
+ This project is licensed under the terms of the [Apache 2.0 License](LICENSE).
generated_images/image7.png ADDED
generated_images/image8.png ADDED
model_index.json ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_class_name": "StableDiffusionPipeline",
3
+ "_diffusers_version": "0.6.0",
4
+ "feature_extractor": ["transformers", "CLIPImageProcessor"],
5
+ "safety_checker": ["stable_diffusion", "StableDiffusionSafetyChecker"],
6
+ "scheduler": ["diffusers", "PNDMScheduler"],
7
+ "text_encoder": ["transformers", "CLIPTextModel"],
8
+ "tokenizer": ["transformers", "CLIPTokenizer"],
9
+ "unet": ["diffusers", "UNet2DConditionModel"],
10
+ "vae": ["diffusers", "AutoencoderKL"]
11
+ }