add property and version modules (#109)

* add property and version modules

Co-authored-by: Bradley Odell <[email protected]>

* add doc for property

---------

Co-authored-by: Bradley Odell <[email protected]>

Author: rahulchaphalkar

crates/openvino/src/lib.rs

@@ -6,7 +6,7 @@
 //!
 //! Check the loaded version of OpenVINO:
 //! ```
-//! assert!(openvino::version().starts_with("2"))
+//! assert!(openvino::version().build_number.starts_with("2"))
 //! ```
 //!
 //! Most interaction with OpenVINO begins with instantiating a [Core]:
@@ -35,12 +35,14 @@ mod model;
 mod node;
 mod partial_shape;
 pub mod prepostprocess;
+mod property;
 mod rank;
 mod request;
 mod resize_algorithm;
 mod shape;
 mod tensor;
 mod util;
+mod version;
 
 pub use crate::core::Core;
 pub use device_type::DeviceType;
@@ -51,30 +53,28 @@ pub use layout::Layout;
 pub use model::{CompiledModel, Model};
 pub use node::Node;
 pub use partial_shape::PartialShape;
+pub use property::{PropertyKey, RwPropertyKey};
 pub use rank::Rank;
 pub use request::InferRequest;
 pub use resize_algorithm::ResizeAlgorithm;
 pub use shape::Shape;
 pub use tensor::Tensor;
+pub use version::Version;
 
 /// Emit the version string of the OpenVINO C API backing this implementation.
 ///
 /// # Panics
 ///
 /// Panics if no OpenVINO library can be found.
-pub fn version() -> String {
-    use std::ffi::CStr;
+pub fn version() -> Version {
     openvino_sys::load().expect("to have an OpenVINO shared library available");
     let mut ov_version = openvino_sys::ov_version_t {
-        // Initialize the fields to default values
-        description: std::ptr::null(),
         buildNumber: std::ptr::null(),
+        description: std::ptr::null(),
     };
     let code = unsafe { openvino_sys::ov_get_openvino_version(&mut ov_version) };
     assert_eq!(code, 0);
-    let version_ptr = { ov_version }.buildNumber;
-    let c_str_version = unsafe { CStr::from_ptr(version_ptr) };
-    let string_version = c_str_version.to_string_lossy().into_owned();
+    let version = Version::from(&ov_version);
     unsafe { openvino_sys::ov_version_free(std::ptr::addr_of_mut!(ov_version)) };
-    string_version
+    version
 }

crates/openvino/src/property.rs

@@ -0,0 +1,136 @@
+use std::borrow::Cow;
+
+/// See [`Property`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__property__c__api.html).
+/// `PropertyKey` represents valid configuration properties for a [crate::Core] instance.
+#[derive(Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
+pub enum PropertyKey {
+    /// A string list of supported read-only properties.
+    SupportedProperties,
+    /// A list of available device IDs.
+    AvailableDevices,
+    /// An unsigned integer value of optimal number of compiled model infer requests.
+    OptimalNumberOfInferRequests,
+    /// A hint for a range for number of async infer requests.
+    /// If device supports streams, the metric provides range for number of IRs per stream.
+    RangeForAsyncInferRequests,
+    /// Information about a range for streams on platforms where streams are supported.
+    RangeForStreams,
+    /// A string value representing a full device name.
+    DeviceFullName,
+    /// A string list of capabilities options per device.
+    DeviceCapabilities,
+    /// The name of a model.
+    ModelName,
+    /// Information about optimal batch size for the given device and network.
+    OptimalBatchSize,
+    /// Maximum batch size which does not cause performance degradation due to memory swap impact.
+    MaxBatchSize,
+    /// Read-write property key.
+    Rw(RwPropertyKey),
+    /// Arbitrary string property key.
+    Other(Cow<'static, str>),
+}
+
+/// Read-write property keys.
+#[derive(Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
+pub enum RwPropertyKey {
+    /// The directory which will be used to store any data cached by plugins.
+    CacheDir,
+    /// The cache mode between optimize_size and optimize_speed.
+    /// If optimize_size is selected, smaller cache files will be created.
+    /// If optimize_speed is selected, loading time will decrease but the cache file size will increase.
+    CacheMode,
+    /// The number of executor logical partitions.
+    NumStreams,
+    /// CPU affinity per thread.
+    Affinity,
+    /// The maximum number of threads that can be used for inference tasks.
+    InferenceNumThreads,
+    /// High-level OpenVINO hint for using CPU pinning to bind CPU threads to processors during inference.
+    HintEnableCpuPinning,
+    /// High-level OpenVINO hint for using hyper threading processors during CPU inference.
+    HintEnableHyperThreading,
+    /// High-level OpenVINO Performance Hints.
+    HintPerformanceMode,
+    /// High-level OpenVINO Hints for the type of CPU core used during inference.
+    HintSchedulingCoreType,
+    /// Hint for device to use specified precision for inference.
+    HintInferencePrecision,
+    /// Backs the Performance Hints by giving
+    /// additional information on how many inference requests the application will be
+    /// keeping in flight usually this value comes from the actual use-case  (e.g.
+    /// number of video-cameras, or other sources of inputs)
+    HintNumRequests,
+    /// Desirable log level.
+    LogLevel,
+    /// High-level OpenVINO model priority hint.
+    HintModelPriority,
+    /// Performance counters.
+    EnableProfiling,
+    /// Device Priorities config option,
+    /// with comma-separated devices listed in the desired priority.
+    DevicePriorities,
+    /// High-level OpenVINO Execution hint
+    /// unlike low-level properties that are individual (per-device), the hints are something that every device accepts
+    /// and turns into device-specific settings
+    /// Execution mode hint controls preferred optimization targets (performance or accuracy) for given model
+    ///
+    /// It can be set to be below value:
+    /// - `"PERFORMANCE"`: Optimize for max performance
+    /// - `"ACCURACY"`: Optimize for max accuracy
+    HintExecutionMode,
+    /// Whether to force terminate TBB when OV Core is destroyed.
+    ForceTbbTerminate,
+    /// Configure `mmap()` use for model read.
+    EnableMmap,
+    /// ?
+    AutoBatchTimeout,
+    /// Arbitrary string property key.
+    Other(Cow<'static, str>),
+}
+
+impl AsRef<str> for PropertyKey {
+    fn as_ref(&self) -> &str {
+        match self {
+            PropertyKey::SupportedProperties => "SUPPORTED_PROPERTIES",
+            PropertyKey::AvailableDevices => "AVAILABLE_DEVICES",
+            PropertyKey::OptimalNumberOfInferRequests => "OPTIMAL_NUMBER_OF_INFER_REQUESTS",
+            PropertyKey::RangeForAsyncInferRequests => "RANGE_FOR_ASYNC_INFER_REQUESTS",
+            PropertyKey::RangeForStreams => "RANGE_FOR_STREAMS",
+            PropertyKey::DeviceFullName => "FULL_DEVICE_NAME",
+            PropertyKey::DeviceCapabilities => "OPTIMIZATION_CAPABILITIES",
+            PropertyKey::ModelName => "NETWORK_NAME",
+            PropertyKey::OptimalBatchSize => "OPTIMAL_BATCH_SIZE",
+            PropertyKey::MaxBatchSize => "MAX_BATCH_SIZE",
+            PropertyKey::Rw(rw) => rw.as_ref(),
+            PropertyKey::Other(s) => s,
+        }
+    }
+}
+
+impl AsRef<str> for RwPropertyKey {
+    fn as_ref(&self) -> &str {
+        match self {
+            RwPropertyKey::CacheDir => "CACHE_DIR",
+            RwPropertyKey::CacheMode => "CACHE_MODE",
+            RwPropertyKey::NumStreams => "NUM_STREAMS",
+            RwPropertyKey::Affinity => "AFFINITY",
+            RwPropertyKey::InferenceNumThreads => "INFERENCE_NUM_THREADS",
+            RwPropertyKey::HintEnableCpuPinning => "ENABLE_CPU_PINNING",
+            RwPropertyKey::HintEnableHyperThreading => "ENABLE_HYPER_THREADING",
+            RwPropertyKey::HintPerformanceMode => "PERFORMANCE_HINT",
+            RwPropertyKey::HintSchedulingCoreType => "SCHEDULING_CORE_TYPE",
+            RwPropertyKey::HintInferencePrecision => "INFERENCE_PRECISION_HINT",
+            RwPropertyKey::HintNumRequests => "PERFORMANCE_HINT_NUM_REQUESTS",
+            RwPropertyKey::LogLevel => "LOG_LEVEL",
+            RwPropertyKey::HintModelPriority => "MODEL_PRIORITY",
+            RwPropertyKey::EnableProfiling => "PERF_COUNT",
+            RwPropertyKey::DevicePriorities => "MULTI_DEVICE_PRIORITIES",
+            RwPropertyKey::HintExecutionMode => "EXECUTION_MODE_HINT",
+            RwPropertyKey::ForceTbbTerminate => "FORCE_TBB_TERMINATE",
+            RwPropertyKey::EnableMmap => "ENABLE_MMAP",
+            RwPropertyKey::AutoBatchTimeout => "AUTO_BATCH_TIMEOUT",
+            RwPropertyKey::Other(s) => s,
+        }
+    }
+}

crates/openvino/src/version.rs

@@ -0,0 +1,20 @@
+use openvino_sys::ov_version_t;
+
+/// Represents OpenVINO version information.
+pub struct Version {
+    /// A string representing OpenVINO version.
+    pub build_number: String,
+    /// A string representing OpenVINO description.
+    pub description: String,
+}
+
+impl From<&ov_version_t> for Version {
+    fn from(ov_version: &ov_version_t) -> Self {
+        let c_str_version = unsafe { std::ffi::CStr::from_ptr(ov_version.buildNumber) };
+        let c_str_description = unsafe { std::ffi::CStr::from_ptr(ov_version.description) };
+        Self {
+            build_number: c_str_version.to_string_lossy().into_owned(),
+            description: c_str_description.to_string_lossy().into_owned(),
+        }
+    }
+}