From 24d6f8aa31ea3917a2209cfd5d2beee53cdc8223 Mon Sep 17 00:00:00 2001 From: Vraj Prajapati Date: Thu, 18 Jul 2024 10:13:06 -0500 Subject: [PATCH] Added TT-Explorer Documentation to docs/tools (#160) --- docs/src/SUMMARY.md | 1 + docs/src/tools.md | 3 ++- docs/src/tt-explorer.md | 5 +++++ 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/src/tt-explorer.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 858d3dabc..e102d29b4 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -10,6 +10,7 @@ - [ttmlir-opt](./ttmlir-opt.md) - [ttmlir-translate](./ttmlir-translate.md) - [ttrt](./ttrt.md) + - [tt-explorer](./tt-explorer.md) - [Flatbuffers](./flatbuffers.md) - [Additional Reading](./additional-reading.md) diff --git a/docs/src/tools.md b/docs/src/tools.md index 26def546d..b7fa562ee 100644 --- a/docs/src/tools.md +++ b/docs/src/tools.md @@ -1,6 +1,7 @@ # Tools -Currently, there are two primary tools that are part of the `ttmlir` project: +Currently, there are a few primary tools that are part of the `ttmlir` project: - `ttmlir-opt`: The `ttmlir` optimizer driver. This tool is used to run the `ttmlir` compiler passes on a `.mlir` source files and is central to developing and testing the compiler. - `ttrt`: This tool is intended to be a swiss army knife for working with flatbuffers generated by the compiler. Its primary role is to inspect and run flatbuffer files. +- [`tt-explorer`](https://github.com/vprajapati-tt/tt-explorer): Visualizer tool for `ttmlir`-powered compiler results. Visualizes from emitted `.mlir` files to display compiled model, attributes, performance results, and provide a platform for human-driven overrides to _gameify_ model tuning. diff --git a/docs/src/tt-explorer.md b/docs/src/tt-explorer.md new file mode 100644 index 000000000..c354ec243 --- /dev/null +++ b/docs/src/tt-explorer.md @@ -0,0 +1,5 @@ +# [`tt-explorer`](https://github.com/vprajapati-tt/tt-explorer) + +Visualizer tool for `ttmlir`-powered compiler results. Visualizes from emitted `.mlir` files to display compiled model, attributes, performance results, and provide a platform for human-driven overrides to _gameify_ model tuning. + +For more information and installation details please check out the repository README at