Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document requirements for torch_mlir_e2e_test #3722

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Document requirements for torch_mlir_e2e_test #3722

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4babb0f
Document requirements for `torch_mlir_e2e_test`
marbre Sep 23, 2024
a1d967c
Add section on flags for end-to-end tests
marbre Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,15 @@ cmake -GNinja -Bbuild \
-DLLVM_ENABLE_ASSERTIONS=ON \
```

#### Flags to run end-to-end tests:

Running the end-to-end execution tests locally requires enabling the native PyTorch extension features and the JIT IR importer, which depends on the
former and defaults to `ON` if not changed:
```shell
-DTORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS=ON \
-DTORCH_MLIR_ENABLE_JIT_IR_IMPORTER=ON \
```

### Building against a pre-built LLVM

If you have built llvm-project separately in the directory `$LLVM_INSTALL_DIR`, you can also build the project *out-of-tree* using the following command as template:
Expand Down Expand Up @@ -396,6 +405,8 @@ Torch-MLIR has two types of tests:
a homegrown testing framework (see
`projects/pt1/python/torch_mlir_e2e_test/framework.py`) and the test suite
lives at `projects/pt1/python/torch_mlir_e2e_test/test_suite/__init__.py`.
The tests require to build with `TORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS` (and
the dependent option `TORCH_MLIR_ENABLE_JIT_IR_IMPORTER`) set to `ON`.

2. Compiler and Python API unit tests. These use LLVM's `lit` testing framework.
For example, these might involve using `torch-mlir-opt` to run a pass and
Expand Down
Loading