objc2-ml-compute 0.3.2

Bindings to the MLCompute framework
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// The layer normalizaion layer.  For more information, refer to https://pytorch.org/docs/stable/nn.html#layernorm.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/mlcompute/mlclayernormalizationlayer?language=objc)
    #[unsafe(super(MLCLayer, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(feature = "MLCLayer")]
    #[deprecated]
    pub struct MLCLayerNormalizationLayer;
);

#[cfg(feature = "MLCLayer")]
extern_conformance!(
    unsafe impl NSObjectProtocol for MLCLayerNormalizationLayer {}
);

#[cfg(feature = "MLCLayer")]
impl MLCLayerNormalizationLayer {
    extern_methods!(
        /// The shape of the axes over which normalization occurs, (W), (H,W) or (C,H,W)
        #[deprecated]
        #[unsafe(method(normalizedShape))]
        #[unsafe(method_family = none)]
        pub unsafe fn normalizedShape(&self) -> Retained<NSArray<NSNumber>>;

        #[cfg(feature = "MLCTensor")]
        /// The beta tensor
        #[deprecated]
        #[unsafe(method(beta))]
        #[unsafe(method_family = none)]
        pub unsafe fn beta(&self) -> Option<Retained<MLCTensor>>;

        #[cfg(feature = "MLCTensor")]
        /// The gamma tensor
        #[deprecated]
        #[unsafe(method(gamma))]
        #[unsafe(method_family = none)]
        pub unsafe fn gamma(&self) -> Option<Retained<MLCTensor>>;

        #[cfg(feature = "MLCTensorParameter")]
        /// The beta tensor parameter used for optimizer update
        #[deprecated]
        #[unsafe(method(betaParameter))]
        #[unsafe(method_family = none)]
        pub unsafe fn betaParameter(&self) -> Option<Retained<MLCTensorParameter>>;

        #[cfg(feature = "MLCTensorParameter")]
        /// The gamma tensor parameter used for optimizer update
        #[deprecated]
        #[unsafe(method(gammaParameter))]
        #[unsafe(method_family = none)]
        pub unsafe fn gammaParameter(&self) -> Option<Retained<MLCTensorParameter>>;

        /// A value used for numerical stability
        #[deprecated]
        #[unsafe(method(varianceEpsilon))]
        #[unsafe(method_family = none)]
        pub unsafe fn varianceEpsilon(&self) -> c_float;

        #[cfg(feature = "MLCTensor")]
        /// Create a layer normalization layer
        ///
        /// Parameter `normalizedShape`: The shape of the axes over which normalization occurs, currently (C,H,W) only
        ///
        /// Parameter `beta`: Training parameter
        ///
        /// Parameter `gamma`: Training parameter
        ///
        /// Parameter `varianceEpsilon`: A small numerical value added to variance for stability
        ///
        /// Returns: A new layer normalization layer.
        #[deprecated]
        #[unsafe(method(layerWithNormalizedShape:beta:gamma:varianceEpsilon:))]
        #[unsafe(method_family = none)]
        pub unsafe fn layerWithNormalizedShape_beta_gamma_varianceEpsilon(
            normalized_shape: &NSArray<NSNumber>,
            beta: Option<&MLCTensor>,
            gamma: Option<&MLCTensor>,
            variance_epsilon: c_float,
        ) -> Option<Retained<Self>>;
    );
}

/// Methods declared on superclass `MLCLayer`.
#[cfg(feature = "MLCLayer")]
impl MLCLayerNormalizationLayer {
    extern_methods!(
        #[deprecated]
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        #[deprecated]
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
    );
}