Skip to content

Commit

Permalink
Push docs and doxygen updates into gh-pages branch
Browse files Browse the repository at this point in the history
  • Loading branch information
Doxygen Bot (GitHub Action) committed Aug 26, 2024
1 parent e8f63c0 commit e9c4fc4
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions PythonPackage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
The Python package, onnxmlir, provides an installable package to use onnx-mlir
compiler in a similar way to onnxruntime. Also the package supports the way to
run model by `utils/RunONNXModel.py`.

The source of the package is located at `onnx-mlir/utils/onnxmlir`. The main python code, `onnxmlir/src/onnxmlir/RunONNXModel.py` should be the same as `onnx-mlir/utils/RunONNXModel.py`. You can use target `OMCreateONNXMLIRSource` to create the installable directory in your build directory.
The package can be installed from your local directory with `pip3 install your_path/onnx-mlir/build/utils/onnxmlir`

Follow instructions in https://packaging.python.org/en/latest/tutorials/packaging-projects/
commands to use under the top directory onnxmlir
```
python3 -m pip install --upgrade build
python3 -m build
#After get the api-token
python3 -m pip install --upgrade twine
python3 -m twine upload --repository testpypi dist/*
```
Different from document, the prompt asked only for the api-token

Examples can be found at onnx-mlir/util/onnxmlir/tests.

0 comments on commit e9c4fc4

Please sign in to comment.