Skip to content

Commit 96488e4

Browse files
authored
Update README.md (#154)
1 parent 9c16348 commit 96488e4

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -134,30 +134,28 @@ But, open an issue if something isn't clear.
134134

135135
## Install
136136

137-
This package is meant to work in concert with host bindings.
138-
Practically speaking that means you need to have *some* package installed that includes mlir python bindings.
139-
140-
So
137+
If you want to just get started/play around:
141138

142139
```shell
143-
$ HOST_MLIR_PYTHON_PACKAGE_PREFIX=<YOUR_HOST_MLIR_PYTHON_PACKAGE_PREFIX> pip install git+https://github.com/makslevental/mlir-python-extras
140+
$ pip install mlir-python-bindings -f https://makslevental.github.io/wheels/
141+
$ pip install git+https://github.com/makslevental/mlir-python-extras
144142
```
145143

146-
where `YOUR_HOST_MLIR_PYTHON_PACKAGE_PREFIX` is (as it says) the package prefix for your chosen host bindings.
147-
**When in doubt about this prefix**, it is everything up until `ir` when you import your bindings, e.g., in `import torch_mlir.ir`, `torch_mlir` is the `HOST_MLIR_PYTHON_PACKAGE_PREFIX` for the torch-mlir bindings.
144+
Alternatively, this [colab notebook](https://drive.google.com/file/d/1NAtf2Yxj_VVnzwn8u_kxtajfVzgbuWhi/view?usp=sharing) (which is the same as [examples/mlir_python_extras.ipynb](examples/mlir_python_extras.ipynb)) has a MWE if you don't want to install anything even.
148145

149-
If you don't have any such package, but you want to experiment anyway, you can install the "stock" upstream bindings first:
150-
151-
```shell
152-
$ pip install mlir-python-bindings -f https://makslevental.github.io/wheels/
153-
```
146+
In reality, this package is meant to work in concert with "host bindings" (some distribution of the actual MLIR Python bindings).
147+
Practically speaking that means you need to have *some* package installed that includes mlir python bindings.
154148

155-
and then
149+
So that means the second line should be amended to
156150

157151
```shell
158-
$ pip install git+https://github.com/makslevental/mlir-python-extras
152+
$ HOST_MLIR_PYTHON_PACKAGE_PREFIX=<YOUR_HOST_MLIR_PYTHON_PACKAGE_PREFIX> \
153+
pip install git+https://github.com/makslevental/mlir-python-extras
159154
```
160155

156+
where `YOUR_HOST_MLIR_PYTHON_PACKAGE_PREFIX` is (as it says) the package prefix for your chosen host bindings.
157+
**When in doubt about this prefix**, it is everything up until `ir` when you import your bindings, e.g., in `import torch_mlir.ir`, `torch_mlir` is the `HOST_MLIR_PYTHON_PACKAGE_PREFIX` for the torch-mlir bindings.
158+
161159
## Examples/Demo
162160

163-
Check [examples](examples) and [tests](tests) for a plethora of example code.
161+
Check [examples](examples) and [tests](tests) for a plethora of example code.

0 commit comments

Comments
 (0)