Skip to content

Commit

Permalink
Add documentation about namespaces (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
nsmithtt authored Jul 1, 2024
1 parent 1f26d46 commit 9cdbbce
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/internal-build.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Internal Build Notes / IRD

- When building the runtime we must use Ubuntu 20.04 docker image
- When making an IRD reservation use `--docker-image
yyz-gitlab.local.tenstorrent.com:5005/tenstorrent/infra/ird-ubuntu-20-04-amd64:latest`
- You'll have to manaully install a newer version of cmake, at least 3.20, the easiest way to do this is to `pip install cmake` and make sure this one is in your path
- You'll want LLVM installation to persist IRD reservations, you can achieve this by:
- mkdir /localdev/$USER/ttmlir-toolchain
Expand Down
14 changes: 14 additions & 0 deletions docs/src/project-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,17 @@
- `tools/python`: Python bindings for the runtime, currently this is where `ttrt` is implemented
- `test`: Test suite
- `tools/ttmlir-opt`: TTMLIR optimizer driver

# Namespaces

- `mlir`: On the compiler side, we use the MLIR namespace for all MLIR types and operations and subnamespace for our dialects.
- `mlir::tt`: Everything ttmlir related is underneath this namespace. Since
we need to subnamespace under `mlir`, just `mlir::tt` seemed better than
`mlir::ttmlir` which feels redundant.
- `mlir::tt::ttir`: The TTIR dialect namespace
- `mlir::tt::ttnn`: The TTNN dialect namespace
- `mlir::tt::ttmetal`: The TTMetal dialect namespace
- `mlir::tt::ttkernel`: The TTKernel dialect namespace
- `tt::runtime`: On the runtime side, we use the `tt::runtime` namespace for all runtime types and operations.
- `tt::runtime::ttnn`: The TTNN runtime namespace
- `tt::runtime::ttmetal`: The TTMetal runtime namespace (not implemented)

0 comments on commit 9cdbbce

Please sign in to comment.