Update doc on lit Filecheck usage FileCheck is installed as a python package in prereqs Change-Id: I2b665a2b9d4be94a2de1d8f2e12410ab634ed484
diff --git a/README.md b/README.md index ddc43c2..b8af29a 100644 --- a/README.md +++ b/README.md
@@ -9,33 +9,33 @@ If you get this project from Project Shodan manifest, you are all set. If not, you need to have following projects as well to build the project successfully. -* [Springbok BSP](https://spacebeaker.googlesource.com/shodan/sw/vec): Under +* [Springbok BSP](https://spacebeaker.googlesource.com/shodan/sw/vec): Under `<dir>/sw/vec` -* [Kelvin BSP](https://spacebeaker.googlesource.com/shodan/sw/kelvin): Under +* [Kelvin BSP](https://spacebeaker.googlesource.com/shodan/sw/kelvin): Under `<dir>/sw/kelvin` -* [IREE](https://github.com/google/iree): Under `<dir>/toolchain/iree` -* [Public ML models](https://spacebeaker.googlesource.com/shodan/ml-models-public): +* [IREE](https://github.com/google/iree): Under `<dir>/toolchain/iree` +* [Public ML models](https://spacebeaker.googlesource.com/shodan/ml-models-public): Under `<dir>/ml/ml-models-public` -* RISC-V 32-bit crosscompile toolchain +* RISC-V 32-bit crosscompile toolchain This project needs to be at `<dir>/sw/vec_iree` ## Code structure -* audio_prep: Audio preprocessing libarary -* build_tools: Utility scripts for the project -* cmake: CMake Macros for the project -* device: Device HAL driver library -* model_util: Runtime utility library for model execution -* native_log: BSP support for the Linux userspace emulation -* risp4ml: Vision preprocessing library (Reduced ISP for ML) -* samples: Codegen and execution of ML models based on IREE - * branch_mul: Branch multiplication example - * microbenchmarks: Currently only contain a convolution 1x1 example - * simple_vec_mul: Point-wise vector multiplication examples -* ssd_postprocess: Vision postprocessing library for Single-Shot Detectors +* audio_prep: Audio preprocessing libarary +* build_tools: Utility scripts for the project +* cmake: CMake Macros for the project +* device: Device HAL driver library +* model_util: Runtime utility library for model execution +* native_log: BSP support for the Linux userspace emulation +* risp4ml: Vision preprocessing library (Reduced ISP for ML) +* samples: Codegen and execution of ML models based on IREE + * branch_mul: Branch multiplication example + * microbenchmarks: Currently only contain a convolution 1x1 example + * simple_vec_mul: Point-wise vector multiplication examples +* ssd_postprocess: Vision postprocessing library for Single-Shot Detectors (SSD) -* ukernel: Custom microkernel library for VMVX and LLVM +* ukernel: Custom microkernel library for VMVX and LLVM ## Build the project @@ -75,15 +75,13 @@ ## Test the executables -In Shodan, this project utilizes LLVM `lit` and `FileCheck` to test the ML -executable performance. The tests are defined in the *_test.run files under +In Shodan, this project utilizes LLVM `lit` and Python `filecheck` to test the +ML executable performance. The tests are defined in the *_test.run files under `<output dir>`. To run the test, at the Shodan top level directory ```bash -lit --path <Filecheck dir> -a <output dir> +lit -a <output dir> ``` -Filecheck in Debian testing is under `/usr/lib/llvm-16/bin` - Default is renode tests for Springbok. Add`-D RUNNER=kelvin` to enable renode tests for Kelvin. Add`-D RUNNER=kelvin_hw` to enable renode tests for Kelvin HW.
diff --git a/audio_prep/mfcc_test.run b/audio_prep/mfcc_test.run index 23b584d..600b280 100644 --- a/audio_prep/mfcc_test.run +++ b/audio_prep/mfcc_test.run
@@ -1,4 +1,4 @@ // UNSUPPORTED: kelvin_hw // RUN: ${TEST_RUNNER_CMD} %S/mfcc_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED
diff --git a/risp4ml/common/image_test.run b/risp4ml/common/image_test.run index 7afb694..5a907ae 100644 --- a/risp4ml/common/image_test.run +++ b/risp4ml/common/image_test.run
@@ -1,4 +1,4 @@ // UNSUPPORTED: kelvin_hw // RUN: ${TEST_RUNNER_CMD} %S/image_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED
diff --git a/risp4ml/isp_stages/blc_test.run b/risp4ml/isp_stages/blc_test.run index dcff7f0..9684a85 100644 --- a/risp4ml/isp_stages/blc_test.run +++ b/risp4ml/isp_stages/blc_test.run
@@ -1,4 +1,4 @@ // UNSUPPORTED: kelvin_hw // RUN: ${TEST_RUNNER_CMD} %S/blc_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED
diff --git a/risp4ml/isp_stages/dg_test.run b/risp4ml/isp_stages/dg_test.run index d18f528..6d7b899 100644 --- a/risp4ml/isp_stages/dg_test.run +++ b/risp4ml/isp_stages/dg_test.run
@@ -1,4 +1,4 @@ // UNSUPPORTED: kelvin_hw // RUN: ${TEST_RUNNER_CMD} %S/dg_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED
diff --git a/risp4ml/isp_stages/downscale_test.run b/risp4ml/isp_stages/downscale_test.run index 7686af8..061a477 100644 --- a/risp4ml/isp_stages/downscale_test.run +++ b/risp4ml/isp_stages/downscale_test.run
@@ -1,3 +1,3 @@ // RUN: ${TEST_RUNNER_CMD} %S/downscale_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED
diff --git a/risp4ml/isp_stages/gamma_test.run b/risp4ml/isp_stages/gamma_test.run index e5951e3..20ef712 100644 --- a/risp4ml/isp_stages/gamma_test.run +++ b/risp4ml/isp_stages/gamma_test.run
@@ -1,3 +1,3 @@ // RUN: ${TEST_RUNNER_CMD} %S/gamma_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED
diff --git a/risp4ml/isp_stages/wbg_test.run b/risp4ml/isp_stages/wbg_test.run index cfdff4f..6c433f8 100644 --- a/risp4ml/isp_stages/wbg_test.run +++ b/risp4ml/isp_stages/wbg_test.run
@@ -1,4 +1,4 @@ // UNSUPPORTED: kelvin_hw // RUN: ${TEST_RUNNER_CMD} %S/wbg_test 2>&1 | tee %t -// RUN: cat %t | FileCheck %s +// RUN: cat %t | filecheck %s // CHECK: PASSED