Go to file
Hanchen Ye 626cfea264 [LegalizeHLSCpp] Support to create AXI interfaces as an optional transform; [QoREstimation][EmitHLSCpp] Support memref CopyOp; [DSE] Move applyLegalizeToHLSCpp to the begining of the pass 2022-03-07 22:39:51 -06:00
docs [Readme] Add a figure for the overall architecture 2022-03-04 02:45:25 -06:00
include [LegalizeHLSCpp] Support to create AXI interfaces as an optional transform; [QoREstimation][EmitHLSCpp] Support memref CopyOp; [DSE] Move applyLegalizeToHLSCpp to the begining of the pass 2022-03-07 22:39:51 -06:00
lib [LegalizeHLSCpp] Support to create AXI interfaces as an optional transform; [QoREstimation][EmitHLSCpp] Support memref CopyOp; [DSE] Move applyLegalizeToHLSCpp to the begining of the pass 2022-03-07 22:39:51 -06:00
polygeist@642b664c2a Bump LLVM to af6b993 2022-02-22 01:18:14 -06:00
samples [Readme] Update c++ and pytorch test instructions; Fix some small errors 2022-02-23 18:03:46 -06:00
test [Test] Add test cases for new passes; Update test cases according to the recent changes, inluding legalize-dataflow, split-function, etc 2022-03-01 23:47:30 -06:00
tools [Transforms] Remove the tileOrderOpt and unrollPointLoops option from applyAffineTiling API 2022-03-01 16:13:50 -06:00
.clang-format mechanical rename hlsld to scalehls; update file structure 2020-09-06 18:05:16 -05:00
.gitignore [Samples] Update the structure of the samples folder 2022-02-20 17:15:16 -06:00
.gitmodules Rename Polygeist to polygeist 2021-09-30 12:20:01 -05:00
CMakeLists.txt Update the path of mlir-clang 2022-01-26 11:33:56 -06:00
LICENSE Update license to Apache 2.0 with LLVM exceptions 2022-01-05 20:34:39 -06:00
README.md [Readme] Add a figure for the overall architecture 2022-03-04 02:45:25 -06:00
build-scalehls.sh Add build-scalehls.sh script; [README] Update build and test instructions; [Polygeist] Update polygeist submodule to avoid gettimeofday failure 2021-11-09 00:49:06 -06:00

README.md

ScaleHLS Project

ScaleHLS is a High-level Synthesis (HLS) framework on MLIR. ScaleHLS can compile HLS C/C++ or PyTorch model to optimized HLS C/C++ in order to generate high-efficiency RTL design using downstream tools, such as Xilinx Vivado HLS.

By using the MLIR framework that can be better tuned to particular algorithms at different representation levels, ScaleHLS is more scalable and customizable towards various applications coming with intrinsic structural or functional hierarchies. ScaleHLS represents HLS designs at multiple levels of abstraction and provides an HLS-dedicated analysis and transform library (in both C++ and Python) to solve the optimization problems at the suitable representation levels. Using this library, we've developed a design space exploration engine to generate optimized HLS designs automatically.

For more details, please see our HPCA'22 paper:

@article{ye2021scalehls,
  title={ScaleHLS: A New Scalable High-Level Synthesis Framework on Multi-Level Intermediate Representation},
  author={Ye, Hanchen and Hao, Cong and Cheng, Jianyi and Jeong, Hyunmin and Huang, Jack and Neuendorffer, Stephen and Chen, Deming},
  journal={arXiv preprint arXiv:2107.11673},
  year={2021}
}

Framework Architecture

Setting this up

Prerequisites

  • cmake
  • ninja
  • clang and lld (recommended)
  • pybind11
  • python3 with numpy

Clone ScaleHLS

$ git clone --recursive git@github.com:hanchenye/scalehls.git
$ cd scalehls

Build ScaleHLS

Run the following script to build ScaleHLS. Note that you can use -j xx to specify the number of parallel linking jobs.

$ ./build-scalehls.sh

After the build, we suggest to export the following paths.

$ export PATH=$PATH:$PWD/build/bin:$PWD/polygeist/build/bin
$ export PYTHONPATH=$PYTHONPATH:$PWD/build/tools/scalehls/python_packages/scalehls_core

Compiling HLS C/C++

To launch the automatic kernel-level design space exploration, run:

$ cd samples/polybench/gemm

$ mlir-clang test_gemm.c -function=test_gemm -memref-fullrank -raise-scf-to-affine -S \
    | scalehls-opt -dse="top-func=test_gemm target-spec=../config.json" -debug-only=scalehls \
    | scalehls-translate -emit-hlscpp > test_gemm_dse.cpp

Meanwhile, we provide a pyscalehls tool to showcase the scalehls Python library:

$ pyscalehls.py test_gemm.c -f test_gemm > test_gemm_pyscalehls.cpp

Compiling PyTorch Model

If you have installed Torch-MLIR, you should be able to run the following test:

$ cd samples/pytorch/resnet18

$ # Parse PyTorch model to TOSA dialect (with mlir_venv activated).
$ # This may take several minutes to compile due to the large amount of weights.
$ python3 export_resnet18_mlir.py | torch-mlir-opt \
    -torchscript-module-to-torch-backend-pipeline="optimize=true" \
    -torch-backend-to-tosa-backend-pipeline="optimize=true" > resnet18.mlir

$ # Optimize the model and emit C++ code.
$ scalehls-opt resnet18.mlir \
    -scalehls-pytorch-pipeline="top-func=forward opt-level=2" \
    | scalehls-translate -emit-hlscpp > resnet18.cpp

Repository Layout

The project follows the conventions of typical MLIR-based projects:

  • include/scalehls and lib for C++ MLIR dialects/passes.
  • polygeist for the C/C++ front-end.
  • samples for C/C++ and PyTorch examples.
  • test for holding regression tests.
  • tools for command line tools.