Skip to content

Commit 855a365

Browse files
committed
updated readme
1 parent aa04b92 commit 855a365

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Latent Diffusion MNIST Experiment
22

3-
Latent Diffusion MNIST Experiment is a Python project exploring the implementation of a latent diffusion model using a variational autoencoder (VAE) and a conditional U-Net. It currently targets the MNIST dataset, but the architecture and training pipeline are intentionally dataset-agnostic and can scale to larger and more complex image domains.
3+
Latent Diffusion MNIST Experiment is a Python project exploring the implementation of a latent diffusion model using a variational autoencoder (VAE) and a conditional U-Net. It currently targets the MNIST dataset, but the architecture and training pipeline are intentionally dataset-agnostic and can scale to larger and more complex image domains with minimal changes.
44

55
## Features
66
- **Modular Architecture** – separate training routines for VAE and U-Net components built on top of Hugging Face Diffusers.
7-
- **Dataset Agnostic Pipeline** – although the repository demonstrates MNIST, the data loaders and model design can be extended to other datasets with minimal changes, retaining most of the training logic from this experiment.
7+
- **Dataset Agnostic Pipeline** – although the repository demonstrates MNIST, the data loaders and model design can be easily extended to other datasets, retaining most of the training logic from this experiment.
88
- **Configurable Training** – hyperparameters (batch size, learning rates, epochs, etc.) are managed via `config.yaml` for reproducible experiments.
99
- **Efficient & Stable Training** – leverages `Accelerate` for device management and distributed training, cosine learning rate schedules, and EMA tracking. Added gradient clipping.
1010
- **Visualization Utilities** – automatic saving of reconstruction and generation plots for monitoring model performance.
11-
- **Gradio App** – ready-to-deploy web app for interactive predictions. Hosted on [Huggingface Spaces](https://huggingface.co/spaces/codinglabsong/aging-gan).
11+
- **Gradio App***Work in Progress*
12+
<!-- - **Gradio App** – ready-to-deploy web app for interactive predictions. Hosted on [Huggingface Spaces](https://huggingface.co/spaces/codinglabsong/aging-gan). -->
1213
- **Developer Tools & CI** – Linting with ruff and black, unit tests with pytest, end‐to‐end smoke tests in GitHub Actions.
1314

1415
## Installation
@@ -61,7 +62,7 @@ The script will load the VAE and EMA-smoothed U-Net weights and produce images s
6162
## Results
6263
### Example Outputs
6364

64-
*Placeholder for generated image examples.*
65+
*Work in Progress*
6566

6667
### Considerations for Improvements
6768

@@ -70,8 +71,9 @@ The script will load the VAE and EMA-smoothed U-Net weights and produce images s
7071
- Integrate more advanced schedulers or guidance techniques.
7172

7273
## Running the Gradio Inference App
74+
*Work in Progress*
7375

74-
This project includes an interactive Gradio app for making predictions with the trained model.
76+
<!-- This project includes an interactive Gradio app for making predictions with the trained model.
7577

7678
1. **Obtain the Trained Model:**
7779
- Ensure that a trained model directory (`models/vae.pth` and `models/ema-unet.pth`) is available in the project root.
@@ -84,7 +86,7 @@ This project includes an interactive Gradio app for making predictions with the
8486
```
8587
- Visit the printed URL (e.g., `http://127.0.0.1:7860`) to interact with the model.
8688

87-
> You can also access the hosted demo on [Huggingface Spaces](https://huggingface.co/spaces/codinglabsong/aging-gan)
89+
> You can also access the hosted demo on [Huggingface Spaces](https://huggingface.co/spaces/codinglabsong/aging-gan) -->
8890

8991

9092
## Testing

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
tqdm
22
matplotlib
33
diffusers[torch]
4-
torchvision
4+
torchvision
5+
gradio

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@
1010
"matplotlib",
1111
"diffusers[torch]",
1212
"torchvision",
13+
"gradio",
1314
],
1415
)

0 commit comments

Comments
 (0)