From 1a04856fd8ab553c3043a4b5af2ec58e4fb47345 Mon Sep 17 00:00:00 2001 From: Philipp van Kempen Date: Tue, 19 Jul 2022 10:30:02 +0200 Subject: [PATCH] add missing component docs files --- docs/components/AUTO_VECTORIZE.md | 27 +++++++++++++++++++++++++++ docs/components/auto_vectorize.rst | 2 ++ docs/components/muriscvnnbyoc.rst | 2 ++ 3 files changed, 31 insertions(+) create mode 100644 docs/components/AUTO_VECTORIZE.md create mode 100644 docs/components/auto_vectorize.rst create mode 100644 docs/components/muriscvnnbyoc.rst diff --git a/docs/components/AUTO_VECTORIZE.md b/docs/components/AUTO_VECTORIZE.md new file mode 100644 index 000000000..a9d2fef4e --- /dev/null +++ b/docs/components/AUTO_VECTORIZE.md @@ -0,0 +1,27 @@ +# Auto-Vectorize Feature + +## Usage + +- Add `-f auto_vectorize` to the command line arguments + +## TODOs: + +- [ ] Configure loop and basic block vectorizer individually. + +## Warning +- Auto vectorization is enables by default (if available) on the following optimization levels: + + - GCC: `-O2` + - LLVM: `-O1` + +## Configuration + +- `auto_vectorize.enable`: Allows to turn off ne auto-vectorization completely (Default: `true`) +- `auto_vectorize.verbose`: Print details about auto vectorization possibilities during compililation. Need to check the MLID stdout artifact or enable `mlif.print_outputs` to be effective (Default: `false`) + +## Compatibility + +- Only RISC-V targets is supported at the momemt +- The supported MLIF toolchains are GCC and LLVM +- A VLEN larger equals 128 is required for this feature +- It seems like this currently needs a ELEN=64 and proper alignment (e.g. `tvmaot.alignment_bytes=8`) for the backend data. TFLMI seems to break with this. diff --git a/docs/components/auto_vectorize.rst b/docs/components/auto_vectorize.rst new file mode 100644 index 000000000..0390dcbf5 --- /dev/null +++ b/docs/components/auto_vectorize.rst @@ -0,0 +1,2 @@ +.. include:: AUTO_VECTORIZE.md + :parser: myst_parser.sphinx_ diff --git a/docs/components/muriscvnnbyoc.rst b/docs/components/muriscvnnbyoc.rst new file mode 100644 index 000000000..7e3257a92 --- /dev/null +++ b/docs/components/muriscvnnbyoc.rst @@ -0,0 +1,2 @@ +.. include:: MURISCVNNBYOC.md + :parser: myst_parser.sphinx_