Skip to content

Commit 7ca4ec9

Browse files
committed
add inline option to docs
1 parent bc44f9e commit 7ca4ec9

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

docs/options.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,23 @@
33
Nautilus provides various runtime options to customize the compilation, which are passed when initializing the nautilus
44
engine.:
55

6-
| Option | Default | Description |
7-
|-----------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
8-
| engine.compilation=[true,false] | true | Activates the compilation of nautilus functions. If the flag is false, all nautilus functions will be directly invoked, which is handy for debugging. |
9-
| engine.backend=[mlir,bc,cpp] | mlir | Sets the specific compilation backend for nautilus functions. |
10-
| dump.all=[true,false] | false | Dumbs intermediate representations all compilation steps. |
11-
| dump.after_tracing=[true,false] | false | Dumbs traces directly after trace generation. |
12-
| dump.after_ssa=[true,false] | false | Dumbs traces after SSA generation. |
13-
| dump.after_ir_creation=[true,false] | false | Dumbs the nautilus ir after generation. |
14-
| dump.after_mlir_generation=[true,false] | false | Dumbs the generated mlir if the MLIR backend is used. |
15-
| dump.after_llvm_generation=[true,false] | false | Dumbs the generated llvm if the MLIR backend is used. |
16-
| dump.after_cpp_generation=[true,false] | false | Dumbs the generated cpp code if the CPP backend is used. |
17-
| dump.after_bc_generation=[true,false] | false | Dumbs the generated byte codes if the Bytecode Interpreter (BC) backend is used. |
18-
| dump.console=[true,false] | false | Enables the dumping of intermediate compilation steps to the console. |
19-
| dump.file=[true,false] | true | Enables the dumping of intermediate compilation steps to a temp folder. |
20-
| dump.graph=[true,false] | false | Dumps a graph representation in either (mermaid or graphvit) to a file. |
21-
| dump.graph.type=[mermaid,graphviz] | graphviz | Sets the type of the graph. |
22-
| dump.graph.full=[true,false] | false | Represents both data and control-flow (full=true) or only the control-flow (full=false). |
23-
| mlir.optimizationLevel=[0,1,2,3] | 3 | Sets the optimization level for the code-generation if the MLIR backend is used. |
24-
| mlir.enableMultithreading=[true,false] | true | Allows MLIR Backend to use multiple threads. |
6+
| Option | Default | Description |
7+
|---------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
8+
| engine.compilation=[true,false] | true | Activates the compilation of nautilus functions. If the flag is false, all nautilus functions will be directly invoked, which is handy for debugging. |
9+
| engine.backend=[mlir,bc,cpp] | mlir | Sets the specific compilation backend for nautilus functions. |
10+
| dump.all=[true,false] | false | Dumbs intermediate representations all compilation steps. |
11+
| dump.after_tracing=[true,false] | false | Dumbs traces directly after trace generation. |
12+
| dump.after_ssa=[true,false] | false | Dumbs traces after SSA generation. |
13+
| dump.after_ir_creation=[true,false] | false | Dumbs the nautilus ir after generation. |
14+
| dump.after_mlir_generation=[true,false] | false | Dumbs the generated mlir if the MLIR backend is used. |
15+
| dump.after_llvm_generation=[true,false] | false | Dumbs the generated llvm if the MLIR backend is used. |
16+
| dump.after_cpp_generation=[true,false] | false | Dumbs the generated cpp code if the CPP backend is used. |
17+
| dump.after_bc_generation=[true,false] | false | Dumbs the generated byte codes if the Bytecode Interpreter (BC) backend is used. |
18+
| dump.console=[true,false] | false | Enables the dumping of intermediate compilation steps to the console. |
19+
| dump.file=[true,false] | true | Enables the dumping of intermediate compilation steps to a temp folder. |
20+
| dump.graph=[true,false] | false | Dumps a graph representation in either (mermaid or graphvit) to a file. |
21+
| dump.graph.type=[mermaid,graphviz] | graphviz | Sets the type of the graph. |
22+
| dump.graph.full=[true,false] | false | Represents both data and control-flow (full=true) or only the control-flow (full=false). |
23+
| mlir.optimizationLevel=[0,1,2,3] | 3 | Sets the optimization level for the code-generation if the MLIR backend is used. |
24+
| mlir.enableMultithreading=[true,false] | true | Allows MLIR Backend to use multiple threads. |
25+
| mlir.inline_invoke_calls=[true,false] | false | Allow MLIR Backend to inline functions that were tagged with NAUTILUS_INLINE |

0 commit comments

Comments
 (0)