Adding `--expected_output=` flag to iree-run-module. (#10433)

This allows for super basic blackbox testing of compiled modules by way
of iree-run-module that does not require any input changes like
iree-check-module does. The flag accepts the same values as
`--function_input` (including npy files) in addition to `(ignored)` for
when a value is not of interest.

When the flag is provided the normal output printing is disabled and
instead a comparison runs and prints detailed information about any
diffs, for example:
```
[FAILED] result[0]: element at index 49 (0) does not match the expected (123); expected that the view is equal to contents of a view of 5x1x10xf32
  expected:
5x1x10xf32=[[0.743973 ... 0 0 123]]
  actual:
5x1x10xf32=[[0.743973 ... 0 0 0]]
```

The matching utilities are intended to be wrapped in gtest C++ matchers
so that they can be used in iree-check-module and other tools but that
is left for future work. This separation is required so that
iree-run-module and other tools using the comparison utilities don't
need to depend on gtest. It also means that users authoring their own
test tools for bare metal/etc can easily use the comparison features.

There are three flags like `--expected_f32_threshold=` (+f16/f64) that
allow for basic threshold overrides. Full customization of the equality
comparisons that do smarter things (ULP, integer ranges, etc) are also
left for future work and what's used here matches iree-check-module's
current behavior.

Fixes #10376.
21 files changed
tree: 40dfd0d407211cde1c4c21d2f1a356b205dd6c8f
  1. .github/
  2. benchmarks/
  3. build_tools/
  4. compiler/
  5. docs/
  6. experimental/
  7. integrations/
  8. llvm-external-projects/
  9. runtime/
  10. samples/
  11. tests/
  12. third_party/
  13. tools/
  14. .bazelignore
  15. .bazelrc
  16. .bazelversion
  17. .clang-format
  18. .gitignore
  19. .gitmodules
  20. .pylintrc
  21. .style.yapf
  22. .yamllint.yml
  23. AUTHORS
  24. BUILD.bazel
  25. CITATION.cff
  26. CMakeLists.txt
  27. configure_bazel.py
  28. CONTRIBUTING.md
  29. LICENSE
  30. README.md
  31. WORKSPACE
README.md

IREE: Intermediate Representation Execution Environment

IREE (Intermediate Representation Execution Environment, pronounced as “eerie”) is an MLIR-based end-to-end compiler and runtime that lowers Machine Learning (ML) models to a unified IR that scales up to meet the needs of the datacenter and down to satisfy the constraints and special considerations of mobile and edge deployments.

See our website for project details, user guides, and instructions on building from source.

CI Status

Project Status

IREE is still in its early phase. We have settled down on the overarching infrastructure and are actively improving various software components as well as project logistics. It is still quite far from ready for everyday use and is made available without any support at the moment. With that said, we welcome any kind of feedback on any communication channels!

Communication Channels

Related Project Channels

  • MLIR topic within LLVM Discourse: IREE is enabled by and heavily relies on MLIR. IREE sometimes is referred to in certain MLIR discussions. Useful if you are also interested in MLIR evolution.

Architecture Overview

IREE Architecture IREE Architecture

See our website for more information.

Presentations and Talks

  • 2021-06-09: IREE Runtime Design Tech Talk (recording and slides)
  • 2020-08-20: IREE CodeGen: MLIR Open Design Meeting Presentation (recording and slides)
  • 2020-03-18: Interactive HAL IR Walkthrough (recording)
  • 2020-01-31: End-to-end MLIR Workflow in IREE: MLIR Open Design Meeting Presentation (recording and slides)

License

IREE is licensed under the terms of the Apache 2.0 License with LLVM Exceptions. See LICENSE for more information.