xref: /llvm-project/mlir/utils/jupyter/README.md (revision 04c66edd3251975fd253e4c4b0e86ea56e8a7f46)
1A Jupyter kernel for mlir (mlir-opt)
2
3This is purely for experimentation. This kernel uses the reproducer runner
4conventions to run passes.
5
6To install:
7
8    python3 -m mlir_opt_kernel.install
9
10To use it, run one of:
11
12```shell
13    jupyter notebook
14    # In the notebook interface, select MlirOpt from the 'New' menu
15    jupyter console --kernel mlir
16```
17
18`mlir-opt` is expected to be either in the `PATH` or `MLIR_OPT_EXECUTABLE` is
19used to point to the executable directly.
20