Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wangzeke committed May 25, 2020
1 parent a9ab630 commit 260ba14
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# Shuhai
Shuhai is a benchmarking-memory tool that allows FPGA programmers to demystify all the underlying details of memories, e.g., HBM and DDR4, on a Xilinx FPGA.
### Two Reasons Why We Need Shuhai?
First, in terms of benchmarking memory, it can be done better on FPGA, rather than on CPU/GPU.
In particular, when benchmarking memory on cpu or gpu, we cannot get rid of the negative effect of cache/TLB in CPUs/GPUs. So there is a lot of work about benchmarking cache in CPUs/GPUs, rather than directly benchmarking memory.
In contrast, when benchmarking memory on the FPGA, the benchmarking engine can directly attach to the memory such that there is no noise between memory and benchmarking engine.
Second, we do not need to reinvent the wheel again for each memory/FPGA. With Shuhai, before implementing the concrete application that contains a particular memory access pattern on the FPGA, we are able to benchmark the corresponding memory access pattern to make sure that the memory side will not be the bottleneck. In case it is, the authors need to tune the implementation to have a more efficient memory access pattern such that your application will not be bound by memory.

## Getting Started

1. Initialize submodules
## 1. Getting Started
```
$ git clone https://github.com/FPGAML/Benchmarking-HBM-DDR.git
$ git clone https://github.com/RC4ML/Shuhai.git
$ git submodule update --init --recursive
```

2. Build hardware project
## 2. Build FPGA Project
```
$ cd hw/
```

read hw/README.md, build vivado project and program bitstream

3. Reboot

4. Build software project
## 3. Build Software Project
```
$ cd sw/
```
Expand Down

0 comments on commit 260ba14

Please sign in to comment.