Skip to content

Commit ee93e00

Browse files
joewjiangcopybara-github
authored andcommitted
Rename Circuit Training
PiperOrigin-RevId: 679214685 Change-Id: I462056ab6b6678a18b63acc4a70fb3b48365568a
1 parent fc5b27a commit ee93e00

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
review_interval: '12 months'
88
} *-->
99

10-
# Circuit Training: An open-source framework for generating chip floor plans with distributed deep reinforcement learning.
10+
# AlphaChip: An open-source framework for generating chip floorplans with distributed deep reinforcement learning.
1111

12-
*Circuit Training* is an open-source framework for generating chip floor plans
13-
with distributed deep reinforcement learning. This framework reproduces the
14-
methodology published in the Nature 2021 paper:
12+
*AlphaChip* is an open-source framework
13+
for generating chip floorplans with distributed deep reinforcement learning.
14+
This framework reproduces the methodology published in the Nature 2021 paper:
1515

1616
*[A graph placement methodology for fast chip design.](https://www.nature.com/articles/s41586-021-03544-w)
1717
Azalia Mirhoseini, Anna Goldie, Mustafa Yazgan, Joe Wenjie Jiang, Ebrahim
@@ -21,14 +21,15 @@ James Laudon, Richard Ho, Roger Carpenter & Jeff Dean, 2021. Nature, 594(7862),
2121
pp.207-212.
2222
[[PDF]](https://www.nature.com/articles/s41586-021-03544-w.epdf?sharing_token=tYaxh2mR5EozfsSL0WHZLdRgN0jAjWel9jnR3ZoTv0PW0K0NmVrRsFPaMa9Y5We9O4Hqf_liatg-lvhiVcYpHL_YQpqkurA31sxqtmA-E1yNUWVMMVSBxWSp7ZFFIWawYQYnEXoBE4esRDSWqubhDFWUPyI5wK_5B_YIO-D_kS8%3D)*
2323

24-
Our hope is that *Circuit Training* will foster further collaborations between
25-
academia and industry, and enable advances in deep reinforcement learning for
26-
Electronic Design Automation, as well as general combinatorial and decision
27-
making optimization problems. Capable of optimizing chip blocks with hundreds of
28-
macros, *Circuit Training* automatically generates floor plans in hours, whereas
29-
baseline methods often require human experts in the loop and can take months.
24+
AlphaChip--one of the first reinforcement learning approaches used to solve a
25+
real-world engineering problem--has led to a proliferation of research in AI
26+
for chips over the past few years. It is now used to design layouts for chips
27+
across Alphabet and outside, and has been extended to various stages of the
28+
design process, including logic synthesis, macro selection, timing optimization,
29+
and more! We hope that researchers will continue building on top of AlphaChip
30+
methodologies and open-source framework. Please see our [blogpost](https://deepmind.google/discover/blog/how-alphachip-transformed-computer-chip-design/) for more information.
3031

31-
Circuit training is built on top of
32+
AlphaChip is built on top of
3233
[TF-Agents](https://github.com/tensorflow/agents) and
3334
[TensorFlow 2.x](https://www.tensorflow.org/) with support for eager execution,
3435
distributed training across multiple GPUs, and distributed data collection
@@ -72,19 +73,19 @@ scaling to 100s of actors.
7273
[script](https://github.com/TILOS-AI-Institute/MacroPlacement/tree/main/CodeElements/FormatTranslators)
7374
to convert LEF/DEF and Bookshelf to the
7475
[Netlist Protocol Buffer](https://github.com/google-research/circuit_training/blob/main/docs/NETLIST_FORMAT.md)
75-
used as the input for circuit training.
76+
used as the input for AlphaChip.
7677

7778
<a id='Installation'></a>
7879

7980
## Installation
8081

81-
> :warning: Circuit Training only supports Linux based OSes.
82+
> :warning: AlphaChip only supports Linux based OSes.
8283
83-
> :warning: Circuit Training requires Python 3.9 or greater.
84+
> :warning: AlphaChip requires Python 3.9 or greater.
8485
8586
## Stable
8687

87-
Circuit Training is a reseach project. We are not currently creating PyPi
88+
AlphaChip is a research project. We are not currently creating PyPi
8889
builds. Stable in this instance is relative to HEAD and means that the code
8990
was tested at this point in time and branched. With upstream libraires
9091
constantly changing; older branches may end up rotting faster than expected.
@@ -109,7 +110,7 @@ $ export CT_VERSION=0.0.4
109110
$ export PYTHON_VERSION=python3.9
110111
$ export DREAMPLACE_PATTERN=dreamplace_20231214_c5a83e5_${PYTHON_VERSION}.tar.gz
111112
# If the verson of TF-Agents in the table is not current, change this command to
112-
# match the version tf-agenst that matches the branch of Circuit Training used.
113+
# match the version tf-agenst that matches the branch of AlphaChip used.
113114
$ export TF_AGENTS_PIP_VERSION=tf-agents[reverb]
114115

115116
# Clone the Repo and checkout the desired branch.
@@ -120,7 +121,7 @@ $ git -C $(pwd)/circuit_training checkout r${CT_VERSION}
120121
### Using the docker
121122

122123
Do not forget to do the [prelimary setup](#preliminary-setup). The cleanest way
123-
to use Circuit Training is to use the docker, these commands will create a
124+
to use AlphaChip is to use the docker, these commands will create a
124125
docker with all the dependencies needed:
125126

126127
```shell
@@ -143,7 +144,7 @@ $ docker run --rm -v ${REPO_ROOT}:/workspace --workdir /workspace circuit_traini
143144

144145
Do not forget to do the [prelimary setup](#preliminary-setup).
145146

146-
Circuit Training installation steps:
147+
AlphaChip installation steps:
147148

148149
* Install our DREAMPlace binary.
149150
* Install TF-Agents and The Placement Cost Binary
@@ -214,8 +215,8 @@ $ git clone https://github.com/google-research/circuit_training.git
214215

215216
### Using the docker
216217

217-
Do not forget to do the [prelimary setup](#preliminary-setup). The cleanest way
218-
to use Circuit Training is to use docker, these commands will create an image
218+
Do not forget to do the [preliminary setup](#preliminary-setup). The cleanest way
219+
to use AlphaChip is to use docker, these commands will create an image
219220
with all the dependencies needed:
220221

221222
```shell
@@ -234,7 +235,7 @@ $ docker run --rm -v ${REPO_ROOT}:/workspace --workdir /workspace circuit_traini
234235

235236
### Install locally
236237

237-
Circuit Training installation steps:
238+
AlphaChip installation steps:
238239

239240
* Install our DREAMPlace binary.
240241
* Install TF-Agents Nightly and the placement cost binary
@@ -328,7 +329,8 @@ $ python3 -mpip install pyunpack>=0.1.2 \
328329
The best quick start is to run the
329330
[end2end smoke test](https://github.com/google-research/circuit_training/tree/main/tools#end-to-end-smoke-test)
330331
and then look at the full distributed example
331-
[Circuit training for Ariane RISC-V](./docs/ARIANE.md). For the pre-training
332+
[AlphaChip for Ariane RISC-V](./docs/ARIANE.md).
333+
For the pre-training
332334
on multiple netlists see [Pre-Training Instruction](./docs/PRETRAINING.md).
333335

334336
<a id='Testing'></a>
@@ -601,8 +603,8 @@ to these principles.
601603
## Main Contributors
602604

603605
We would like to recognize the following individuals for their code
604-
contributions, discussions, and other work to make the release of the Circuit
605-
Training library possible.
606+
contributions, discussions, and other work to make the release of the AlphaChip
607+
library possible.
606608

607609
* Sergio Guadarrama
608610
* Summer Yue

0 commit comments

Comments
 (0)