Update docs to add `input_type` flag (#6122)
Reflect changes introduced in https://github.com/google/iree/pull/6030
Co-authored-by: CindyLiu <hcindyl@google.com>
Co-authored-by: Scott Todd <scotttodd@google.com>
diff --git a/docs/developers/developing_iree/benchmarking.md b/docs/developers/developing_iree/benchmarking.md
index ff08628..3694cf1 100644
--- a/docs/developers/developing_iree/benchmarking.md
+++ b/docs/developers/developing_iree/benchmarking.md
@@ -22,7 +22,7 @@
$ bazel run //iree/tools:iree-translate -- \
-iree-mlir-to-vm-bytecode-module \
-iree-hal-target-backends=vmvx \
- $PWD/iree/tools/test/iree-benchmark-module.mlir \
+ $PWD/iree/samples/models/simple_abs.mlir \
-o /tmp/module.fb
```
@@ -33,7 +33,7 @@
--module_file=/tmp/module.fb \
--driver=vmvx \
--entry_function=abs \
- --function_input=i32=-2
+ --function_input=f32=-2
```
You'll see output like
@@ -80,7 +80,7 @@
--module_file=/tmp/module.fb \
--driver=vmvx \
--entry_function=abs \
- --function_input=i32=-2
+ --function_input=f32=-2
```
```shell
@@ -108,6 +108,7 @@
```shell
$ build/iree/tools/iree-translate \
+ -iree-input-type=mhlo \
-iree-mlir-to-vm-bytecode-module \
-iree-flow-export-benchmark-funcs \
-iree-hal-target-backends=vmvx \
diff --git a/docs/developers/developing_iree/developer_overview.md b/docs/developers/developing_iree/developer_overview.md
index eb7347a..64aad5d 100644
--- a/docs/developers/developing_iree/developer_overview.md
+++ b/docs/developers/developing_iree/developer_overview.md
@@ -88,7 +88,7 @@
```
For a more complex example, here's how to run IREE's complete transformation
-pipeline targeting the VMLA backend on the
+pipeline targeting the VMVX backend on the
[fullyconnected.mlir](https://github.com/google/iree/blob/main/iree/test/e2e/models/fullyconnected.mlir)
model file:
@@ -118,8 +118,8 @@
$ ../iree-build/iree/tools/iree-translate \
-iree-mlir-to-vm-bytecode-module \
-iree-hal-target-backends=vmvx \
- $PWD/iree/tools/test/iree-run-module.mlir \
- -o /tmp/simple.vmfb
+ $PWD/iree/samples/models/simple_abs.mlir \
+ -o /tmp/simple_abs_vmvx.vmfb
```
Custom translations may also be layered on top of `iree-translate`, see
@@ -133,15 +133,15 @@
This program can be used in sequence with `iree-translate` to translate a
`.mlir` file to an IREE module and then execute it. Here is an example command
-that executes the simple `simple.vmfb` compiled from `simple.mlir` above on
-IREE's VMLA driver:
+that executes the simple `simple_abs_vmvx.vmfb` compiled from `simple_abs.mlir`
+above on IREE's VMVX driver:
```shell
$ ../iree-build/iree/tools/iree-run-module \
- --module_file=/tmp/simple.vmfb \
+ --module_file=/tmp/simple_abs_vmvx.vmfb \
--driver=vmvx \
--entry_function=abs \
- --function_input=i32=-2
+ --function_input=f32=-2
```
### iree-check-module
@@ -154,6 +154,7 @@
```shell
$ ../iree-build/iree/tools/iree-translate \
+ -iree-input-type=mhlo \
-iree-mlir-to-vm-bytecode-module \
-iree-hal-target-backends=vmvx \
$PWD/iree/test/e2e/xla_ops/abs.mlir \
@@ -176,12 +177,12 @@
function as exported by default and running all of them.
For example, to execute the contents of
-[iree/tools/test/iree-run-mlir.mlir](https://github.com/google/iree/blob/main/iree/tools/test/iree-run-mlir.mlir):
+[iree/samples/models/simple_abs.mlir](https://github.com/google/iree/blob/main/iree/samples/models/simple_abs.mlir):
```shell
$ ../iree-build/iree/tools/iree-run-mlir \
- $PWD/iree/tools/test/iree-run-mlir.mlir \
- -function-input="i32=-2" \
+ $PWD/iree/samples/models/simple_abs.mlir \
+ -function-input="f32=-2" \
-iree-hal-target-backends=vmvx
```
@@ -193,7 +194,7 @@
For example, to inspect the module translated above:
```shell
-$ ../iree-build/iree/tools/iree-dump-module /tmp/simple.vmfb
+$ ../iree-build/iree/tools/iree-dump-module /tmp/simple_abs_vmvx.vmfb
```
### Useful generic flags
diff --git a/docs/developers/developing_iree/profiling_vulkan_gpu.md b/docs/developers/developing_iree/profiling_vulkan_gpu.md
index 8fb76b5..3b4369e 100644
--- a/docs/developers/developing_iree/profiling_vulkan_gpu.md
+++ b/docs/developers/developing_iree/profiling_vulkan_gpu.md
@@ -37,8 +37,9 @@
```shell
# First translate into a VM bytecode module
$ /path/to/iree/build/iree/tools/iree-translate -- \
+ -iree-input-type=mhlo \
-iree-mlir-to-vm-bytecode-module \
- --iree-hal-target-backends=vulkan-spirv \
+ -iree-hal-target-backends=vulkan-spirv \
/path/to/mhlo-dot.mlir \
-o /tmp/mhlo-dot.vmfb
