Update README.md
Browse files
README.md
CHANGED
|
@@ -3,9 +3,91 @@ license: apache-2.0
|
|
| 3 |
language:
|
| 4 |
- en
|
| 5 |
metrics:
|
| 6 |
-
-
|
|
|
|
| 7 |
pipeline_tag: unconditional-image-generation
|
| 8 |
tags:
|
| 9 |
-
-
|
| 10 |
-
-
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
language:
|
| 4 |
- en
|
| 5 |
metrics:
|
| 6 |
+
- FID
|
| 7 |
+
- IS
|
| 8 |
pipeline_tag: unconditional-image-generation
|
| 9 |
tags:
|
| 10 |
+
- generative-adversarial-network
|
| 11 |
+
- pytorch
|
| 12 |
+
- dcgan
|
| 13 |
+
- deep-learning
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
# Model Card for DCGAN (PyTorch)
|
| 17 |
+
|
| 18 |
+
## Model Details
|
| 19 |
+
|
| 20 |
+
### Model Description
|
| 21 |
+
|
| 22 |
+
This is a **Deep Convolutional Generative Adversarial Network (DCGAN)** implemented in **PyTorch**.
|
| 23 |
+
It is trained to generate synthetic images that resemble the target dataset distribution.
|
| 24 |
+
|
| 25 |
+
- **Developed by:** Abhishek C.
|
| 26 |
+
- **Funded by [optional]:** Self Funded
|
| 27 |
+
- **Shared by:** None
|
| 28 |
+
- **Model type:** Generative Adversarial Network (DCGAN)
|
| 29 |
+
- **Language(s):** N/A (Image generation)
|
| 30 |
+
- **License:** Apache-2.0
|
| 31 |
+
- **Finetuned from model [optional]:** Not applicable (trained from scratch)
|
| 32 |
+
---
|
| 33 |
+
|
| 34 |
+
## Uses
|
| 35 |
+
|
| 36 |
+
### Direct Use
|
| 37 |
+
- Generating synthetic images from random noise vectors (`z ~ N(0,1)`).
|
| 38 |
+
- Data augmentation for research and experimentation.
|
| 39 |
+
- Educational purposes to study GAN training and generative modeling.
|
| 40 |
+
|
| 41 |
+
### Downstream Use
|
| 42 |
+
- Fine-tuning the discriminator or generator on domain-specific datasets.
|
| 43 |
+
- Using the pretrained generator as an initialization for conditional GANs.
|
| 44 |
+
|
| 45 |
+
### Out-of-Scope Use
|
| 46 |
+
- Medical or safety-critical applications without validation.
|
| 47 |
+
- Misuse for generating harmful or misleading content.
|
| 48 |
+
|
| 49 |
+
---
|
| 50 |
+
|
| 51 |
+
## Bias, Risks, and Limitations
|
| 52 |
+
- Generated images may contain artifacts if training is insufficient.
|
| 53 |
+
- Quality depends heavily on dataset diversity and size.
|
| 54 |
+
- Model may amplify dataset biases.
|
| 55 |
+
|
| 56 |
+
### Recommendations
|
| 57 |
+
- Always evaluate generated images before downstream use.
|
| 58 |
+
- Do not use in decision-critical tasks.
|
| 59 |
+
- Use larger datasets for stable performance.
|
| 60 |
+
|
| 61 |
+
---
|
| 62 |
+
|
| 63 |
+
## How to Get Started with the Model
|
| 64 |
+
|
| 65 |
+
```python
|
| 66 |
+
import torch
|
| 67 |
+
from torch import nn
|
| 68 |
+
|
| 69 |
+
# Load pretrained generator (example structure)
|
| 70 |
+
class Generator(nn.Module):
|
| 71 |
+
def __init__(self, nz=100, ngf=64, nc=3):
|
| 72 |
+
super().__init__()
|
| 73 |
+
self.main = nn.Sequential(
|
| 74 |
+
nn.ConvTranspose2d(nz, ngf*8, 4, 1, 0, bias=False),
|
| 75 |
+
nn.BatchNorm2d(ngf*8),
|
| 76 |
+
nn.ReLU(True),
|
| 77 |
+
nn.ConvTranspose2d(ngf*8, ngf*4, 4, 2, 1, bias=False),
|
| 78 |
+
nn.BatchNorm2d(ngf*4),
|
| 79 |
+
nn.ReLU(True),
|
| 80 |
+
nn.ConvTranspose2d(ngf*4, ngf*2, 4, 2, 1, bias=False),
|
| 81 |
+
nn.BatchNorm2d(ngf*2),
|
| 82 |
+
nn.ReLU(True),
|
| 83 |
+
nn.ConvTranspose2d(ngf*2, nc, 4, 2, 1, bias=False),
|
| 84 |
+
nn.Tanh()
|
| 85 |
+
)
|
| 86 |
+
|
| 87 |
+
def forward(self, input):
|
| 88 |
+
return self.main(input)
|
| 89 |
+
|
| 90 |
+
# Example usage
|
| 91 |
+
netG = Generator()
|
| 92 |
+
noise = torch.randn(16, 100, 1, 1)
|
| 93 |
+
fake_images = netG(noise)
|