[NVIDIA] Prepare setup.py for PyPi (#1001)

* Fix issues related to auditwheel and final .whl package

* Refactored setup.py, to make consistent case where OPENVINO_SRC_DIR was provided and openvino downloaded from the internet

* Updated openvino_nvidia/__init__.py to improve registration of NVIDIA plugin; update README.,d by adding the section related to how build python package for NVIDIA plugin

---------

Co-authored-by: Denis Kotov <[email protected]>

Author: redradist

modules/nvidia_plugin/.gitignore

@@ -8,3 +8,4 @@ dist/
 
 report_api.xml
 report_op.xml
+wheel/packages/openvino_nvidia/lib/

modules/nvidia_plugin/README.md

@@ -192,6 +192,60 @@ During compilation of the openvino_nvidia_gpu_plugin, user could specify the fol
 nvidia-smi --query-gpu=compute_cap --format=csv
 ```
 
+## Python package
+
+Python package could be built using `wheel/setup.py` file provided in nvidia_plugin folder.
+
+### Prerequisites
+Run the following commands as prerequisites to `setup.py`:
+```bash
+export OPENVINO_HOME=<OPENVINO_HOME_DIR> # If not provided, setup.py will download openvino automatically
+python3 -m pip install wheel
+```
+
+### Building the package
+To build it, use simply the following command:
+```bash
+python3 ./wheel/setup.py bdist_wheel
+```
+
+### Installing the package
+To install:
+```bash
+python3 ./wheel/setup.py install
+```
+
+### Usage
+Now you can use `openvino-nvidia` package, here is example:
+```python
+import openvino_nvidia
+import openvino as ov
+
+core = ov.Core()
+model = core.read_model(model=...)
+core.compile_model(model=model, device_name="NVIDIA")
+```
+During the import of package `openvino_nvidia` it tries to register itself in `openvino` package.
+Registration happens in "lightweight" manner, it means if "NVIDIA" plugin already registered than it does nothing.
+If you want forcely overwrite a path to plugin library you can do it by importing from `openvino_nvidia` package attribute `force_install`:
+```python
+from openvino_nvidia import force_install # will overwrite a path to plugin library
+import openvino as ov
+
+core = ov.Core()
+model = core.read_model(model=...)
+core.compile_model(model=model, device_name="NVIDIA")
+```
+For symmetry there is also `install` attribute:
+```python
+from openvino_nvidia import install # will register plugin if it does not yet
+import openvino as ov
+
+core = ov.Core()
+model = core.read_model(model=...)
+core.compile_model(model=model, device_name="NVIDIA")
+```
+
 ## Supported Layers and Limitations
 The plugin supports IRv10 and higher. The list of supported layers and its limitations are defined in [cuda_opset.md](docs/cuda_opset.md).
 

modules/nvidia_plugin/build.sh

@@ -9,10 +9,17 @@ fi
 
 BUILD_JOBS=${BUILD_JOBS:-$(nproc)}
 BUILD_TYPE=${BUILD_TYPE:-Release}
-BUILD_TARGETS=${BUILD_TARGETS:-"ov_nvidia_func_tests ov_nvidia_unit_tests openvino_nvidia_gpu_plugin benchmark_app"}
-WHEEL_VERSION=${WHEEL_VERSION:-"2022.3.0"}
+
+ENABLE_WHEEL=${ENABLE_WHEEL:-"OFF"}
+WHEEL_VERSION=${WHEEL_VERSION:-"2025.3.0"}
+WHEEL_TARGET=""
+if [ "$ENABLE_WHEEL" = "ON" ]; then
+    WHEEL_TARGET="ie_wheel"
+fi
+
+BUILD_TARGETS=${BUILD_TARGETS:-"${WHEEL_TARGET} ov_nvidia_func_tests ov_nvidia_unit_tests openvino_nvidia_gpu_plugin benchmark_app"}
 ENABLE_TESTS=${ENABLE_TESTS:-"ON"}
-ENABLE_FUNCTIONAL_TESTS=${ENABLE_FUNCTIONAL_TESTS:-"OFF"}
+ENABLE_FUNCTIONAL_TESTS=${ENABLE_FUNCTIONAL_TESTS:-"ON"}
 
 [[ -n "${OPENVINO_HOME}" ]] || { echo "OPENVINO_HOME environment variable is expected"; exit 1; }
 [[ -n "${OPENVINO_CONTRIB}" ]] || { echo "OPENVINO_CONTRIB environment variable is expected"; exit 1; }
@@ -43,6 +50,7 @@ cmake "${OPENVINO_HOME}" \
       -DENABLE_PLUGINS_XML=ON \
       -DENABLE_TESTS="${ENABLE_TESTS}" \
       -DENABLE_FUNCTIONAL_TESTS="${ENABLE_FUNCTIONAL_TESTS}" \
+      -DENABLE_WHEEL="${ENABLE_WHEEL}" \
       -DBUILD_arm_plugin=OFF \
       -DBUILD_java_api=OFF \
       -DBUILD_llama_cpp_plugin=OFF \

modules/nvidia_plugin/wheel/packages/openvino_nvidia/__init__.py

@@ -18,22 +18,44 @@ def _get_lib_file_extension() -> str:
         return "dylib"
 
 
-def _register_nvidia_plugin():
+def _register_nvidia_plugin(force=False):
     import openvino
     openvino_package_dir = os.path.dirname(os.path.abspath(openvino.__file__))
     openvino_package_libs_dir = os.path.join(openvino_package_dir, "libs")
     openvino_nvidia_gpu_package_dir = os.path.dirname(os.path.abspath(__file__))
-    openvino_nvidia_gpu_library = os.path.join(openvino_nvidia_gpu_package_dir, f"../libopenvino_nvidia_gpu_plugin.{_get_lib_file_extension()}")
+    openvino_nvidia_gpu_library = os.path.join(openvino_nvidia_gpu_package_dir, f"./lib/libopenvino_nvidia_gpu_plugin.{_get_lib_file_extension()}")
 
     xml_file = os.path.join(openvino_package_libs_dir, "plugins.xml")
+    xml_file_updated = False
     tree = ET.parse(xml_file).getroot()
     plugins = tree.find("plugins")
-    if all(plugin.get('name') != 'NVIDIA' for plugin in plugins.iter('plugin')):
-        plugins.append(Element('plugin', {'name': 'NVIDIA', 'location': openvino_nvidia_gpu_library}))
+    
+    if force:
+        for plugin in plugins:
+            if plugin.tag == "plugin" and plugin.get("name") == "NVIDIA":
+                plugins.remove(plugin)
+                plugins.append(Element('plugin', {'name': 'NVIDIA', 'location': openvino_nvidia_gpu_library}))
+                xml_file_updated = True
+    else:
+        if all(plugin.get('name') != 'NVIDIA' for plugin in plugins.iter('plugin')):
+            plugins.append(Element('plugin', {'name': 'NVIDIA', 'location': openvino_nvidia_gpu_library}))
+            xml_file_updated = True
+    
+    if xml_file_updated:
         with open(xml_file, "w") as f:
             f.write(ET.tostring(tree).decode('utf8'))
 
 
+def __getattr__(name):
+    if name == "install":
+        _register_nvidia_plugin()
+    elif name == "force_install":
+        _register_nvidia_plugin(True)
+    else:
+        raise AttributeError(f"module {__name__} has no attribute {name}")
+
+
 _register_nvidia_plugin()
 
-__version__ = "2024.1.0"
+
+__version__ = "2025.3.0"

modules/nvidia_plugin/wheel/requirements.txt

@@ -1 +1 @@
-openvino==2024.1.0
+openvino==2025.3.0