Skip to content

Commit e74ae21

Browse files
committed
[Docs] update installation instructions; beautify; news
1 parent f54299b commit e74ae21

File tree

1 file changed

+34
-18
lines changed

1 file changed

+34
-18
lines changed

README.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,37 @@
11
<div align="center">
22

33
# DevFormer
4-
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_red.svg)](https://dppbench.streamlit.app/)![example workflow](https://github.com/kaist-silab/DPPBench/actions/workflows/pytest.yml/badge.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![python_sup](https://img.shields.io/badge/python-3.7+-blue.svg?)](https://www.python.org/downloads/release/python-370/)
4+
5+
[![arXiv](https://img.shields.io/badge/arXiv-paper-b31b1b.svg)](https://arxiv.org/abs/2205.13225) [![Slack](https://img.shields.io/badge/slack-chat-611f69.svg?logo=slack)](https://join.slack.com/t/rl4co/shared_invite/zt-1ytz2c1v4-0IkQ8NQH4TRXIX8PrRmDhQ)
6+
![example workflow](https://github.com/ai4co/devformer/actions/workflows/pytest.yml/badge.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![python_sup](https://img.shields.io/badge/python-3.9+-blue.svg?)](https://www.python.org/downloads/release/python-390/)
57

68
<p align="center">
79
<img src="pages/assets/objective.png" width="500"/>
8-
</p>
10+
</p>
911

1012
</div>
1113

1214
This repository contains the benchmark for the decoupling capacitor placement problem (DPP) and the accompanying paper "DevFormer: A Symmetric Transformer for Context-Aware Device Placement", accepted at ICML 2023. The benchmark is designed to evaluate the performance of the proposed DevFormer architecture and to facilitate future research in hardware design optimization.
1315

14-
> The DPP and its multi-port variants are now available as environments in [RL4CO](https://github.com/kaist-silab/rl4co)! 🚀
1516

16-
## Setup
17+
## 📰 News
18+
- September 2024: the DPP has been featured in the NeurIPS 2024 paper [ReEvo](https://github.com/ai4co/reevo), where a new SOTA heuristic was discovered by LLMs
19+
- September 2023: The DPP and its multi-port variants are now available as environments in [RL4CO](https://github.com/ai4co/rl4co)
20+
- May 2023: The paper "DevFormer: A Symmetric Transformer for Context-Aware Device Placement" has been accepted at ICML 2023 🎉
21+
22+
## 📦 Setup
1723

1824
### Install dependencies
19-
```bash
20-
# Clone the repository and cd into it
21-
git clone https://github.com/kaist-silab/DPP_benchmark.git && cd DPP_benchmark
2225

23-
# Automatically install dependencies with light the torch
24-
pip install light-the-torch && python3 -m light_the_torch install --upgrade -r requirements.txt
26+
After cloning the repository, you can install the dependencies with the following commands:
27+
```bash
28+
git clone https://github.com/ai4co/devformer.git && cd devformer
29+
pip install -e ".[app,dev]"
2530
```
26-
The above script will [automatically install](https://github.com/pmeier/light-the-torch) PyTorch with the right GPU version for your system. Alternatively, you can use `pip install -r requirements.txt`
2731

28-
## Usage
32+
This will also install the development dependencies, which include the necessary packages for running the tests and the Streamlit application.
33+
34+
## 🚀 Usage
2935
### Simulator
3036
* Using the simulator to obtain the cost of a solution:
3137

@@ -47,9 +53,9 @@ You may also have a look at the arguments under [src/options.py](src/options.py)
4753
```bash
4854
python3 run.py --problem dpp --model devformer --resume data/dpp/pretrained/CSE_2000_epoch-50.pt --eval_only
4955
```
50-
56+
5157
* How to train DevFormer
52-
58+
5359
```bash
5460
python3 run.py --problem dpp --model devformer --N_aug 4 --training_mode IL --train_dataset data/dpp/training_2000_new.pkl --guiding_action data/dpp/guiding_2000_new.pkl --EE --SE --batch_size 200
5561
```
@@ -60,12 +66,12 @@ Additionally, the folder [scripts/](scripts/) contains scripts to reproduce the
6066
- There may be problems on multiple GPUs due to the current handling of DataParallel. You may run `export CUDA_VISIBLE_DEVICES=0` to use only one GPU.
6167
- When running the `run.py` script, if data has not been download it will start downloading automatically. If you want to download the data manually, or if there are any issues with Google Drive, you may access the data at the [following link](https://drive.google.com/file/d/1cANSJRW7STCl_7cWacDajWMXcEUQG1SK/view) and place extract the content of the `.zip` archive at this repository root `.`.
6268

63-
---
69+
---
6470

65-
## DPP Simulator GUI
71+
## DPP Simulator GUI 🎨
6672
<p align="center">
6773
<img src="pages/assets/catchy.png" width="500"/>
68-
</p>
74+
</p>
6975

7076

7177
The application is based on [Streamlit](https://streamlit.io/) which allows for web GUIs in Python. To run the application locally, run the following command:
@@ -94,9 +100,10 @@ Most radical modifications are not supported in Streamlit, so we hack our way an
94100
There are many ways to deploy the app, among which on our own server. However, Streamlit provides a [free hosting service](https://docs.streamlit.io/streamlit-cloud/get-started/deploy-an-app) that is sufficient for our purposes. To deploy the app, simply follow the instructions there or click the "deploy" button after running the app locally!
95101

96102
---
97-
### Cite us
98103

99-
If you find this repository useful, please consider citing our paper:
104+
105+
### 🤩 Citation
106+
If you find DevFormer valuable for your research or applied projects:
100107

101108
```
102109
@article{kim2023devformer,
@@ -107,3 +114,12 @@ If you find this repository useful, please consider citing our paper:
107114
organization={PMLR}
108115
}
109116
```
117+
118+
119+
---
120+
121+
<div align="center">
122+
<a href="https://github.com/ai4co">
123+
<img src="https://raw.githubusercontent.com/ai4co/assets/main/svg/ai4co_animated_full.svg" alt="AI4CO Logo" style="width: 30%; height: auto;">
124+
</a>
125+
</div>

0 commit comments

Comments
 (0)