Skip to content

Commit b733b98

Browse files
authored
[Doc][NFC] Fix typography in aircc documentation (Xilinx#301)
1 parent b4e107d commit b733b98

File tree

2 files changed

+21
-22
lines changed

2 files changed

+21
-22
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ runtimes and compilers.
1212

1313
-----
1414

15-
<p align="center">Copyright&copy; 2019-2022 Advanced Micro Devices, Inc.</p>
15+
<p align="center">Copyright&copy; 2019-2023 Advanced Micro Devices, Inc.</p>

docs/aircc.md

+20-21
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# AIRCC - The AIR Compiler Driver
22

33
## Overview
4-
`aircc.py` is a compiler driver processing air programs. It takes the AIR MLIR
4+
`aircc.py` is a compiler driver processing air programs. It takes the `AIR` MLIR
55
dialect as input and produces AIE binaries plus host library code as output.
66

77
## Usage
@@ -36,7 +36,7 @@ optional arguments:
3636
```
3737

3838
Python:
39-
```
39+
```Python
4040
import air.compiler.aircc.main as aircc
4141

4242
# same as command line options above, but as a python list
@@ -47,31 +47,31 @@ aircc.run(air_module, aircc_options)
4747

4848
## Compilation pipeline
4949

50-
aircc.py runs several code transformations and tools to generate executable
51-
code from AIR dialect.
50+
`aircc.py` runs several code transformations and tools to generate executable
51+
code from `AIR` dialect.
5252

5353
The first steps are to:
54-
- Run herd placement (`air-place-herds`) using the aircc.py commmand line options
55-
- Run AIR dialect to AIR dialect conversion (`air-to-aie`)
54+
- Run herd placement (`air-place-herds`) using the `aircc.py` commmand line options
55+
- Run `AIR` dialect to `AIE` dialect conversion (`air-to-aie`)
5656

57-
The `air-to-aie` pass will generate an AIE dialect MLIR module for each AIR
58-
dialect partition in the program and will add runtime metadata to the AIR
57+
The `air-to-aie` pass will generate an `AIE` dialect MLIR module for each `AIR`
58+
dialect partition in the program and will add runtime metadata to the `AIR`
5959
dialect program.
6060

6161
### Lowering of control code
6262

63-
The AIR dialect program is lowered to control code with the following pipeline:
64-
- Run `air-to-std` to generate AIRRt dialect from AIR dialect.
65-
- Run `airrt-to-llvm` to lower AIRRt dialect to LLVM dialect
63+
The `AIR` dialect program is lowered to control code with the following pipeline:
64+
- Run `air-to-std` to generate `AIRRt` dialect from `AIR` dialect.
65+
- Run `airrt-to-llvm` to lower `AIRRt` dialect to `LLVM` dialect
6666
- Bufferize any remaing tensors
67-
- Lower standard dialects (linalg, scf, memref, ...) to LLVM dialect
68-
- Translate LLVM dialect to LLVM IR (`aie-translate`)
67+
- Lower standard dialects (`linalg`, `scf`, `memref`, ...) to `LLVM` dialect
68+
- Translate `LLVM` dialect to LLVM IR (`aie-translate`)
6969
- Compile LLVM IR to object code (`opt` and `clang`)
7070

7171
### Lowering of AIE code
7272

73-
For each AIE dialect module generated by the `air-to-aie` pass, aircc will:
74-
- Run `aiecc.py` on the AIE dialect module. This generates an AIE elf file for
73+
For each `AIE` dialect module generated by the `air-to-aie` pass, `aircc` will:
74+
- Run `aiecc.py` on the `AIE` dialect module. This generates an AIE `.elf` file for
7575
every core in every herd in the partition and generates C++ code to configure the
7676
partition at runtime (using the `-aie-generate-xaiev2` option).
7777
- Generate a C++ wrapper defining a namespace to hold each partition's
@@ -81,13 +81,12 @@ runtime and to user programs. An example is shown below.
8181
The generated C++ wrappers are compiled and linked with the controlled code
8282
generated by the MLIR passes into a single library. This can be a shared library
8383
to be loaded at runtime or a static library linked into an executable. The AIE
84-
elf files are not part of the generated library and must be available to load
84+
`.elf` files are not part of the generated library and must be available to load
8585
into memory at runtime.
8686

87-
Example C++ wrapper generated by aircc.py:
88-
```
89-
namespace air {
90-
namespace partitions {
87+
Example C++ wrapper generated by `aircc.py`:
88+
```c++
89+
namespace air::partitions {
9190

9291
// One namespace for each partition in the
9392
// program using the MLIR symbol names
@@ -99,4 +98,4 @@ namespace partition_1 {
9998
}
10099

101100
}
102-
}
101+
```

0 commit comments

Comments
 (0)