openvino 0.11.0

High-level bindings for OpenVINO.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use std::borrow::Cow;
use std::convert::Infallible;
use std::ffi::CString;
use std::fmt::{Display, Formatter};
use std::str::FromStr;

/// `DeviceType` represents accelerator devices.
#[derive(Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub enum DeviceType<'a> {
    /// [CPU Device](https://docs.openvino.ai/2024/openvino-workflow/running-inference/inference-devices-and-modes/cpu-device.html)
    CPU,
    /// [GPU Device](https://docs.openvino.ai/2024/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.html)
    GPU,
    /// [NPU Device](https://docs.openvino.ai/2024/openvino-workflow/running-inference/inference-devices-and-modes/npu-device.html)
    NPU,
    /// [GNA Device](https://docs.openvino.ai/2024/openvino_docs_OV_UG_supported_plugins_GNA.html)
    #[deprecated = "Deprecated since OpenVINO 2024.0; use NPU device instead"]
    GNA,
    /// Arbitrary device.
    Other(Cow<'a, str>),
}

impl DeviceType<'_> {
    /// Creates a device type with owned string data.
    pub fn to_owned(&self) -> DeviceType<'static> {
        match self {
            DeviceType::CPU => DeviceType::CPU,
            DeviceType::GPU => DeviceType::GPU,
            DeviceType::NPU => DeviceType::NPU,
            #[allow(deprecated)]
            DeviceType::GNA => DeviceType::GNA,
            DeviceType::Other(s) => DeviceType::Other(Cow::Owned(s.clone().into_owned())),
        }
    }
}

impl AsRef<str> for DeviceType<'_> {
    fn as_ref(&self) -> &str {
        match self {
            DeviceType::CPU => "CPU",
            DeviceType::GPU => "GPU",
            DeviceType::NPU => "NPU",
            #[allow(deprecated)]
            DeviceType::GNA => "GNA",
            DeviceType::Other(s) => s,
        }
    }
}

impl<'a> From<&'a DeviceType<'a>> for &'a str {
    fn from(value: &'a DeviceType) -> Self {
        value.as_ref()
    }
}

impl From<DeviceType<'_>> for CString {
    fn from(value: DeviceType) -> Self {
        CString::new(value.as_ref()).expect("a valid C string")
    }
}

impl<'a> From<&'a str> for DeviceType<'a> {
    fn from(s: &'a str) -> Self {
        match s {
            "CPU" => DeviceType::CPU,
            "GPU" => DeviceType::GPU,
            "NPU" => DeviceType::NPU,
            #[allow(deprecated)]
            "GNA" => DeviceType::GNA,
            s => DeviceType::Other(Cow::Borrowed(s)),
        }
    }
}

impl FromStr for DeviceType<'static> {
    type Err = Infallible;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(DeviceType::from(s).to_owned())
    }
}

impl Display for DeviceType<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.into())
    }
}