Merge pull request #6 from ankandrew/ankandrew/0.3.0

Make ONNX variants optional

Author: ankandrew

.github/workflows/main.yaml

@@ -29,7 +29,7 @@ jobs:
           cache: 'poetry'
 
       - name: Install dependencies
-        run: poetry install --all-extras
+        run: make install
 
       - name: Check format
         run: make check_format

.github/workflows/secret-scanning.yaml

@@ -17,3 +17,5 @@ jobs:
           fetch-depth: 0
       - name: Secret Scanning
         uses: trufflesecurity/trufflehog@main
+        with:
+          extra_args: --results=verified,unknown

Makefile

@@ -6,6 +6,7 @@ SRC_PATHS := open_image_models/ test/
 help:
 	@echo "Available targets:"
 	@echo "  help             : Show this help message"
+	@echo "  install          : Install project with all dev/test/docs/train dependencies"
 	@echo "  format           : Format code using Ruff format"
 	@echo "  check_format     : Check code formatting with Ruff format"
 	@echo "  ruff             : Run Ruff linter"
@@ -16,6 +17,10 @@ help:
 	@echo "  checks           : Check format, lint, and test"
 	@echo "  clean            : Clean up caches and build artifacts"
 
+install:
+	@echo "==> Installing project with dev/test/docs/train dependencies..."
+	poetry install --with dev,test,docs
+
 .PHONY: format
 format:
 	@echo "==> Sorting imports..."

README.md

@@ -57,6 +57,10 @@ To install open-image-models via pip, use the following command:
 pip install open-image-models
 ```
 
+> [!NOTE]
+> To install with GPU or hardware acceleration support, use: `pip install open-image-models[gpu]`. The following
+> optional extras are available: `gpu`, `openvino`, `directml`, and `qnn`.
+
 ## Available Models
 
 ### Object Detection
@@ -124,7 +128,7 @@ To start contributing or to begin development, you can follow these steps:
     ```
 2. Install all dependencies using [Poetry](https://python-poetry.org/docs/#installation):
     ```shell
-    poetry install --all-extras
+    make install
     ```
 3. To ensure your changes pass linting and tests before submitting a PR:
     ```shell

docs/contributing.md

@@ -9,7 +9,7 @@ To start contributing or to begin development, you can follow these steps:
     ```
 2. Install all dependencies using [Poetry](https://python-poetry.org/docs/#installation):
     ```shell
-    poetry install --all-extras
+    make install
     ```
 3. To ensure your changes pass linting and tests before submitting a PR:
     ```shell

docs/installation.md

@@ -5,5 +5,6 @@ pip install open-image-models
 ```
 
 ???+ info
-    Currently, **ONNX** framework is used to run the models. When installing `open-image-models`, the corresponding
-    version **GPU**/**CPU** should be installed based on your machine architecture.
+    The models currently run using the ONNX framework. Depending on your system, you may want to install support for GPU
+    or other hardware accelerators. Use optional extras like `gpu`, `openvino`, `directml`, or `qnn` to tailor the
+    installation to your machine. For example: `pip install open-image-models[gpu]`.

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "open-image-models"
-version = "0.2.2"
+version = "0.3.0"
 description = "Pre-trained image models using ONNX for fast, out-of-the-box inference."
 authors = ["ankandrew <[email protected]>"]
 readme = "README.md"
@@ -31,23 +31,23 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.10"
-numpy = ">=1.20"
-# Install onnxruntime-gpu only on systems other than macOS or Raspberry Pi
-onnxruntime-gpu = { version = ">=1.19.2", markers = "sys_platform != 'darwin' and platform_machine != 'armv7l' and platform_machine != 'aarch64' and (platform_system == 'Linux' or platform_system == 'Windows')" }
-# Fallback to onnxruntime for macOS, Raspberry Pi, and other unsupported platforms
-onnxruntime = { version = ">=1.19.2", markers = "sys_platform == 'darwin' or platform_machine == 'armv7l' or platform_machine == 'aarch64'" }
+numpy = "*"
+onnxruntime = { version = ">=1.19.2" }
 opencv-python = "*"
 tqdm = "*"
 rich = "*"
 
-
-# Optional packages for creating the docs
-mkdocs-material = { version = "*", optional = true }
-mkdocstrings = { version = "*", extras = ["python"], optional = true }
-mike = { version = "*", optional = true }
+# ONNX package variants (for different hardware accelerator)
+onnxruntime-gpu = { version = "*", optional = true }
+onnxruntime-openvino = { version = "*", optional = true }
+onnxruntime-directml = { version = "*", optional = true }
+onnxruntime-qnn = { version = "*", optional = true }
 
 [tool.poetry.extras]
-docs = ["mkdocs-material", "mkdocstrings", "mike"]
+gpu = ["onnxruntime-gpu"]
+openvino = ["onnxruntime-openvino"]
+directml = ["onnxruntime-directml"]
+qnn = ["onnxruntime-qnn"]
 
 [tool.poetry.group.test.dependencies]
 pytest = "*"
@@ -58,6 +58,11 @@ mypy = "*"
 ruff = "*"
 pylint = "*"
 
+[tool.poetry.group.docs.dependencies]
+mkdocs-material = "*"
+mkdocstrings = { version = "*", extras = ["python"] }
+mike = "*"
+
 [tool.ruff]
 line-length = 120
 target-version = "py310"