Skip to content

Commit e847fce

Browse files
committed
Improvements to README.md.
1 parent 65c87a8 commit e847fce

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,30 @@ which were used for this project:
2929
- iverilog (v12)
3030
- python3 (v3.11.0)
3131

32+
**Please note that iverilog v13 (development release) is not supported.**
33+
34+
To install Python 3.11:
35+
```
36+
$ conda create -n codex python=3.11
37+
$ conda activate codex
38+
```
39+
40+
Install [ICARUS Verilog](https://github.com/steveicarus/iverilog):
41+
```
42+
$ git clone https://github.com/steveicarus/iverilog.git && cd iverilog \
43+
&& git checkout v12-branch \
44+
&& sh ./autoconf.sh && ./configure && make -j4\
45+
&& make install
46+
```
47+
3248
You will also need the following Python packages:
3349

3450
```
3551
% pip install langchain langchain-openai langchain-nvidia-ai-endpoints
3652
```
3753

54+
We plan to provide a Dockerfile and backwards compatibility mode with a prebuilt jsonl soon.
55+
3856
### Usage
3957

4058
The evalution harness is run using make and various evaluation parameters can be set as below:
@@ -45,6 +63,8 @@ mkdir -p build/
4563
make
4664
```
4765

66+
Evaluation can be sped up by providing the `-j` flag to make, such as `-j4` to run 4 worker processes.
67+
4868
Available tasks are `code-complete-iccad2023` and `spec-to-rtl` with each referencing their corresponding `dataset_$task` directory containig the problems. Problem themselves are identical between the two datasets and only the task format changes.
4969

5070
Valid models are listed at the top of `scripts/sv-generate`. The number of in-context learning examples can be between 0-4, and given with `--with-examples`. Samples to collect per problem are given by `--with-samples`. Finally, model temperature and top_p can be set to --with-temperature and --with-top-p, respectively.

0 commit comments

Comments
 (0)