Skip to content

Commit

Permalink
Merge branch 'bg_fix' into 'dev'
Browse files Browse the repository at this point in the history
Added white background to README image

See merge request hwdesign/ips/accelerators/sauria!2
  • Loading branch information
jfornt-bsc committed Feb 15, 2024
2 parents 54fe8d5 + 3191f70 commit 0912cbe
Show file tree
Hide file tree
Showing 3 changed files with 1,040 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
url = https://github.com/verilator/verilator.git
[submodule "RTL/src/dma/redma"]
path = RTL/src/dma/redma
url = ../../peripherals/memory-management/redma.git
url = https://github.com/bsc-loca/redma
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The accelerator can natively compute convolution and general matrix-matrix multi

Maintainer: Jordi Fornt Mas ([email protected])

![diagram](diagram.svg?raw=true){width=60%}
<img src="diagram.svg" width="750">

## Documentation

Expand All @@ -19,25 +19,37 @@ Check out the project's Wiki (https://gitlab.bsc.es/hwdesign/ips/accelerators/sa

## Installation

After cloning the repository and selecting the branch, run the following command to update all the submodules needed:
After cloning the repository and selecting the branch, run the following command to update all the submodules:

```bash
git submodule update --init --recursive
```

## Running Simulations

SAURIA can be emulated using Verilator v4.224. We have observed issues with older and newer versions, so we recommend using a local installation as described below. A testbench for simulation with commercial RTL simulators (e.g. Synopsys VCS or Questa) is also provided.

The first step is to install Verilator, which can be done as follows:
To install Verilator v4.224 locally, run:

```bash
source setup.sh
cd tools/
source install_verilator.sh
```

Before starting a simulation, we generate a set of random convolutions and GEMMs using Python:
To use the Python script that generates random stimuli for the simulations, install the required packages into your Python environment by using pip:

```bash
pip install -r Python/requirements_pip.txt
```

Or, alternatively, using Conda:

```bash
conda install --file Python/requirements_pip.txt
```

## Running Simulations

First, we generate a set of random convolutions and GEMMs using Python:

```bash
source setup.sh
Expand Down Expand Up @@ -75,6 +87,10 @@ If you use SAURIA in your work, you can cite the following paper:
doi={10.1109/TVLSI.2023.3286122}}
```

## Contributing

If you would like to contribute to SAURIA, please contact [email protected].

## Licensing

SAURIA is released under the [Solderpad v2.1 license](https://solderpad.org/licenses/SHL-2.1/).
Loading

0 comments on commit 0912cbe

Please sign in to comment.