Skip to content

Commit 1d3ef33

Browse files
authored
Merge pull request chairc#134 from chairc/dev
docs: Update running locally in README.
2 parents f823819 + ee4022a commit 1d3ef33

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,21 @@ We named this project IDDM: Integrated Design Diffusion Model. It aims to reprod
5151

5252
If you have any questions, please check [**the existing issues**](https://github.com/chairc/Integrated-Design-Diffusion-Model/issues/9) first. If the issue persists, feel free to open a new one for assistance, or you can contact me via email at chenyu1998424@gmail.com or chairc1998@163.com. **If you think my project is interesting, please give me a ⭐⭐⭐Star⭐⭐⭐ :)**
5353

54-
#### Running Locally
54+
#### Running Locally
5555

5656
Use the `git clone` or directly download the `zip` file of this repository's code, and then configure the environment locally to run it.
5757

5858
```bash
5959
git clone https://github.com/chairc/Integrated-Design-Diffusion-Model.git
6060
cd Integrated-Design-Diffusion-Model
61+
# Run the project in a virtual environment (recommended)
62+
conda create -n iddm python=3.10
63+
pip install -r requirements.txt
64+
# Train the model
65+
cd iddm/tools
66+
python train.py --xxx xxx # Replace --xxx with your training parameters
67+
# Generate images
68+
python generate.py --xxx xxx # Replace --xxx with your generation parameters
6169
```
6270

6371
#### Installation
@@ -114,7 +122,7 @@ pip install . # Or python setup.py install
114122
- [x] [2023-09-16] Support other image generation.
115123
- [x] [2023-11-09] Adding a more advanced U-Net network model.
116124
- [x] [2023-11-09] Support generate larger-sized images.
117-
- [x] [2023-12-06] Reconstruct the overall structure of the model.
125+
- [x] [2023-12-06] Refactor the overall structure of the model.
118126
- [x] [2024-01-23] Adding visual webui training interface.
119127
- [x] [2024-02-18] Support low-resolution generated images for super-resolution enhancement.[~~Super resolution model, the effect is uncertain~~]
120128
- [x] [2024-03-12] Adding PLMS Sampling Method.
@@ -124,10 +132,10 @@ pip install . # Or python setup.py install
124132
- [x] [2024-11-13] Adding the deployment of image-generating Sockets and Web server.
125133
- [x] [2024-11-26] Adding PSNR and SSIM calculators to verify super resolution image quality.
126134
- [x] [2024-12-10] Adding pretrain model download.
127-
- [x] [2024-12-25] Reconstruct the overall structure of the trainer.
135+
- [x] [2024-12-25] Refactor the overall structure of the trainer.
128136
- [x] [2025-03-08] Support PyPI install.
129137
- [ ] [Maybe 2025-01-31] Adding the deployment of Docker and image.
130-
- [ ] [To be determined] Reconstruct the project by Baidu PaddlePaddle.
138+
- [ ] [To be determined] Refactor the project by Baidu PaddlePaddle.
131139
- [ ] [To be determined] ~~Use Latent Diffusion and reduce GPU memory usage~~
132140

133141

README_zh.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@
5757
```bash
5858
git clone https://github.com/chairc/Integrated-Design-Diffusion-Model.git
5959
cd Integrated-Design-Diffusion-Model
60+
# 在虚拟环境中运行项目(推荐)
61+
conda create -n iddm python=3.10
62+
pip install -r requirements.txt
63+
# 训练模型
64+
cd iddm/tools
65+
python train.py --xxx xxx # 用个人参数替换-xxx
66+
# 生成图像
67+
python generate.py --xxx xxx # 用个人参数替换-xxx
6068
```
6169

6270
#### 安装

0 commit comments

Comments
 (0)