From a16411e7779a4da359967050fd0459993a95e149 Mon Sep 17 00:00:00 2001
From: hsharif3 <hsharif3@illinois.edu>
Date: Tue, 23 Mar 2021 00:56:16 +0000
Subject: [PATCH] Update TensorRT README.md
---
hpvm/projects/hpvm-tensor-rt/README.md | 48 +++++++-------------------
1 file changed, 12 insertions(+), 36 deletions(-)
diff --git a/hpvm/projects/hpvm-tensor-rt/README.md b/hpvm/projects/hpvm-tensor-rt/README.md
index d3aad77a43..f5e0c546c4 100644
--- a/hpvm/projects/hpvm-tensor-rt/README.md
+++ b/hpvm/projects/hpvm-tensor-rt/README.md
@@ -4,29 +4,21 @@
### Dependencies
-- CUDA-9.1 or above
- - Your device must have a CUDA-enabled nVidia GPU
- - CUBLAS-9.1 or above - included with CUDA by default
+- CUDA >= 9.1
-- cuDNN-7.0 or above
+- cuDNN >= 7
-- `cmake >= 3.18`
+### Building Tensor Runtime
-- `make >= 4`
+Tensor Runtime and the DNN sources using the Tensor runtime are built with the unified HPVM build system. These
+can also be separately built. HPVM Tensor Runtime can be built as:
-- `gcc < 8` or `3.2 <= clang < 9`
- - We have an upperbound for compiler version because CUDA doesn't support too recent compilers
+```
+make -j ${NUM_THREADS} tensor_runtime
+```
-### Building the Tensor Runtime
+The tensor runtime is built as a static library under `build/lib/liibtensor_runtime.a`
-The following commands will compile the tensor runtime library (`build/libtensor_runtime.a`)
-as well as a number of exemplary benchmarks (DNN models):
-
-```shell
-mkdir build && cd build
-cmake ../
-make -j
-```
### Tensor Runtime APIs
@@ -38,26 +30,10 @@ make -j
- For examples of using `tensor_runtime` functions, see `dnn_sources/src/alexnet_cifar10.cc`.
- Also, try running `build/alexnet_cifar10` which is compiled from that file and runnable out of the box.
-## Developer Notes
### Directory Structure
-- ./tensor_runtime:
- - ./tensor_runtime/include/: Include files for Tensor Runtime
- - ./tensor_runtime/include/tensor_signatures.cc: Include file with Tensor RT signatures
- - NOTE: UPDATE this with updated API
- - ./tensor_runtime/src/: HPVM TensorRT sources
+- `tensor_runtime`:
-- ./dnn_sources:
- - ./dnn_sources/src/${BENCH}.cc: Per Bench FULL-precision source
- - ./dnn_sources/src/half/${BENCH}.cc: Per Bench HALF-precision source
- - ./dnn_sources/src/promise/${BENCH}.cc: Per Bench Layer-API source
-
-- ./bin:
- - ./bin/install_runtime.sh: Script for moving Tensor RT files to ./lib
- - ./bin/run_autotuner.py: Python script for running Autotuner experiments
- - ./bin/setup_tyler_paths.sh: Tyler-specific path setup for Tensor RT
- - ./bin/setup_jetson.sh: Jetson board specific path setup for Tensor RT
- - ./bin/setup_cuda_paths.sh: Place-holder script for setting CUDA paths
- - ./bin/swing_selection.py: Script for hardware mapping
- - NOTE: Includes the L2,L1 norm mapping to hardware knobs
+- `dnn_sources1`:
+
--
GitLab