Skip to content

Commit

Permalink
Added TT-Explorer Documentation to docs/tools (#160)
Browse files Browse the repository at this point in the history
  • Loading branch information
vprajapati-tt authored Jul 18, 2024
1 parent 20c339c commit 24d6f8a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 2 additions & 1 deletion docs/src/tools.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions docs/src/tt-explorer.md
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/vprajapati-tt/tt-explorer?tab=readme-ov-file#tt-explorer>

0 comments on commit 24d6f8a

Please sign in to comment.