Skip to content
This repository was archived by the owner on Feb 7, 2025. It is now read-only.

Commit fd74813

Browse files
authored
Update README.md (#328)
1 parent 4987b2b commit fd74813

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,49 @@
33
</p>
44

55
# MONAI Generative Models
6-
Prototyping repository for generative models to be integrated into MONAI core.
6+
Prototyping repository for generative models to be integrated into MONAI core, MONAI tutorials, and MONAI model zoo.
77
## Features
8-
* Network architectures: Diffusion Model, Autoencoder-KL, VQ-VAE, (Multi-scale) Patch-GAN discriminator.
9-
* Diffusion Model Schedulers: DDPM, DDIM, and PNDM.
8+
* Network architectures: Diffusion Model, Autoencoder-KL, VQ-VAE, Autoregressive transformers, (Multi-scale) Patch-GAN discriminator.
9+
* Diffusion Model Noise Schedulers: DDPM, DDIM, and PNDM.
1010
* Losses: Adversarial losses, Spectral losses, and Perceptual losses (for 2D and 3D data using LPIPS, RadImageNet, and 3DMedicalNet pre-trained models).
11-
* Metrics: Multi-Scale Structural Similarity Index Measure (MS-SSIM) and Maximum Mean Discrepancy (MMD).
12-
* Diffusion Models and Latent Diffusion Models Inferers classes (compatible with MONAI style) containing methods to train, sample synthetic images, and obtain the likelihood of inputted data.
11+
* Metrics: Multi-Scale Structural Similarity Index Measure (MS-SSIM) and Fréchet inception distance (FID).
12+
* Diffusion Models, Latent Diffusion Models, and VQ-VAE + Transformer Inferers classes (compatible with MONAI style) containing methods to train, sample synthetic images, and obtain the likelihood of inputted data.
1313
* MONAI-compatible trainer engine (based on Ignite) to train models with reconstruction and adversarial components.
1414
* Tutorials including:
15-
* How to train VQ-VAEs, VQ-GANs, AutoencoderKLs, Diffusion Models and Latent Diffusion Models on 2D and 3D data.
15+
* How to train VQ-VAEs, VQ-GANs, VQ-VAE + Transformers, AutoencoderKLs, Diffusion Models, and Latent Diffusion Models on 2D and 3D data.
1616
* Train diffusion model to perform conditional image generation with classifier-free guidance.
1717
* Comparison of different diffusion model schedulers.
18-
* Diffusion models with different parameterisation (e.g. v prediction and epsilon parameterisation).
18+
* Diffusion models with different parameterizations (e.g., v-prediction and epsilon parameterization).
19+
* Anomaly Detection using VQ-VAE + Transformers and Diffusion Models.
1920
* Inpainting with diffusion model (using Repaint method)
2021
* Super-resolution with Latent Diffusion Models (using Noise Conditioning Augmentation)
2122

2223
## Roadmap
2324
Our short-term goals are available in the [Milestones](https://github.com/Project-MONAI/GenerativeModels/milestones)
24-
section of the repository and this [document](https://docs.google.com/document/d/1vEjrr6dSWUnzmP-Nfc7Y6NpnWdT6fUBK/edit?usp=sharing&ouid=118224691516664207451&rtpof=true&sd=true).
25+
section of the repository.
2526

26-
In the longer term, we aim to integrate the generative models into the MONAI core library (supporting tasks such as,
27+
In the longer term, we aim to integrate the generative models into the MONAI core repository (supporting tasks such as,
2728
image synthesis, anomaly detection, MRI reconstruction, domain transfer)
2829

2930
## Installation
3031
To install MONAI Generative Models, it is recommended to clone the codebase directly:
3132
```
3233
git clone https://github.com/Project-MONAI/GenerativeModels.git
3334
```
34-
This command will create a GenerativeModels/ folder in your current directory. You can install it by running:
35+
This command will create a GenerativeModels/ folder in your current directory. You can install it by running the following:
3536
```
3637
cd GenerativeModels/
3738
python setup.py install
3839
```
3940

4041
## Contributing
4142
For guidance on making a contribution to MONAI, see the [contributing guidelines](https://github.com/Project-MONAI/GenerativeModels/blob/main/CONTRIBUTING.md).
43+
44+
## Community
45+
Join the conversation on Twitter [@ProjectMONAI](https://twitter.com/ProjectMONAI) or join our [Slack channel](https://forms.gle/QTxJq3hFictp31UM9).
46+
47+
## Links
48+
- Website: https://monai.io/
49+
- Code: https://github.com/Project-MONAI/GenerativeModels
50+
- Project tracker: https://github.com/Project-MONAI/GenerativeModels/projects
51+
- Issue tracker: https://github.com/Project-MONAI/GenerativeModels/issues

0 commit comments

Comments
 (0)