Skip to content

Commit

Permalink
Added FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
cansik committed Oct 8, 2023
1 parent a03b0cb commit 6a6dbaa
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,55 @@ brew install wget cmake protobuf git git-lfs

The pre-built wheel packages should be in the `dist` directory.

## FAQ

#### Installation

> pip install onnxruntime-silicon returns the following error: Could not find a version that satisfies the requirement onnxruntime-silicon
This indicates either that the Python version is not supported (currently only `3.8`, `3.9`, `3.10`, `3.11`) or that the python installation is not built for `arm64`. You can check this by running the following command:

```bash
file $(which python) | grep -q arm64 && echo "Python for arm64 found" || echo "Python for arm64 has not been found"
```

#### Import ONNX Runtime

> import onnxruntime reaises the exception: ModuleNotFoundError: No module named 'onnxruntime'
It seems that onnxruntime has not been installed yet, please run `python -m pip install onnxruntime-silicon`. Check if it has been installed correctly with the following command:

```bash
python -m pip freeze | grep -q onnxruntime-silicon && echo "ONNX runtime for arm64 found" || echo "No ONNX runtime for arm64 found"
```

#### Import ONNX Runtime Silicon

> import onnxruntime-silicon raises the exception: ModuleNotFoundError: No module named 'onnxruntime-silicon'
`onnxruntime-silicon` is a dropin-replacement for `onnxruntime`. After [installing](#Install) the package, everything works the same as with the original `onnxruntime`. Import the package like this: `import onnxruntime`.

#### Another Issue

If your specific issue is not answered by the [FAQ](#FAQ) and there is not already an [issue]([url](https://github.com/cansik/onnxruntime-silicon/issues/)) solved or open, please [open a new issue](https://github.com/cansik/onnxruntime-silicon/issues/new/choose) for it. Provide the following information:

- MacOS version and architecture
- Python version and architecture
- Pip version
- ONNX Runtime version

You can also run the following command and copy paste it's output into the issue:

```bash
echo ""; \
echo "Operating System: $(uname -s) $(uname -r)"; \
echo "Architecture: $(uname -m)"; \
echo "Python Version: $(python --version 2>&1)"; \
echo "Python Architecture: $(python -c 'import platform; print(platform.architecture()[0])')"; \
echo "Python Executable: $(file $(which python))"; \
echo "PIP Version: $(pip --version | awk '{print $2}')"; \
echo ""
```

## About
MIT License - Copyright (c) 2023 Florian Bruggisser

0 comments on commit 6a6dbaa

Please sign in to comment.