Metadata-Version: 2.1
Name: ncs2-device-plugin
Version: 0.0.1
Summary: Intel NCS2 device plugin for Kubernetes
Home-page: https://github.com/adaptant-labs/ncs2-device-plugin
Author: Adaptant Labs
Author-email: labs@adaptant.io
License: Apache 2.0
Description: # Intel NCS2 device plugin for Kubernetes
        
        [![PyPI](https://img.shields.io/pypi/v/ncs2-device-plugin.svg)](https://pypi.python.org/pypi/ncs2-device-plugin)
        
        A Kubernetes device plugin for the Intel Neural Compute Stick 2 (NCS2) / Intel Movidius MyriadX
        
        ## Annotations
        
        Annotations are produced for the per-device full device name, allowing for different device types to be explicitly
        targeted, regardless of their insertion order into the system:
        
        ```
        # For a single device
        ncs2.intel.com/MYRIAD.name: Intel Movidius Myriad X VPU
        
        # For multiple devices
        ncs2.intel.com/MYRIAD.0.name: Intel Movidius Myriad X VPU
        ...
        ```
        ## Node Labels
        
        Node labels are produced for the number of devices and per-device optimization capabilities:
        
        ```
        intel.com/ncs2=<number of NCS2 devices>
        
        # For a single device
        ncs2.intel.com/MYRIAD.FP16=true
        
        # For multiple devices
        ncs2.intel.com/MYRIAD.0.FP16=true
        ...
        ```
        
        ## USB Hotplug Event Reconciliation
        
        Node labels and annotations are reconciled on the node each time a USB device is added or removed from the system. This
        can be seen below:
        
        ```
        2020-11-16 00:16:52 INFO     Discovered 1 NCS2 device(s):
        2020-11-16 00:16:52 INFO     	MYRIAD: Intel Movidius Myriad X VPU, Optimizations: ['FP16']
        2020-11-16 00:16:52 INFO     Applying initial labels and annotations to current node...
        2020-11-16 00:16:52 INFO     Reconciling node sgx-celsius-w550power
        2020-11-16 00:16:52 INFO     Starting USB monitor...
        2020-11-16 00:17:04 INFO     Received a USB remove event for Device('/sys/devices/pci0000:00/0000:00:14.0/usb1/1-4')
        2020-11-16 00:17:04 INFO     Reconciling node sgx-celsius-w550power
        2020-11-16 00:17:26 INFO     Received a USB add event for Device('/sys/devices/pci0000:00/0000:00:14.0/usb1/1-4')
        2020-11-16 00:17:26 INFO     Reconciling node sgx-celsius-w550power
        ```
        
        ## Features and bugs
        
        Please file feature requests and bugs in the [issue tracker][tracker].
        
        ## Acknowledgements
        
        This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant
        agreement No 825480 ([SODALITE]).
        
        ## License
        
        `ncs2-device-plugin` is licensed under the terms of the Apache 2.0 license, the full
        version of which can be found in the LICENSE file included in the distribution.
        
        [tracker]: https://github.com/adaptant-labs/ncs2-device-plugin/issues
        [SODALITE]: https://sodalite.eu
Keywords: kubernetes
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Hardware
Classifier: Topic :: System :: Monitoring
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
