objc2_ml_compute/generated/
MLCEmbeddingDescriptor.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ptr::NonNull;
4use objc2::__framework_prelude::*;
5use objc2_foundation::*;
6
7use crate::*;
8
9extern_class!(
10    /// The MLCEmbeddingDescriptor specifies an embedding layer descriptor
11    ///
12    /// See also [Apple's documentation](https://developer.apple.com/documentation/mlcompute/mlcembeddingdescriptor?language=objc)
13    #[unsafe(super(NSObject))]
14    #[derive(Debug, PartialEq, Eq, Hash)]
15    #[deprecated]
16    pub struct MLCEmbeddingDescriptor;
17);
18
19extern_conformance!(
20    unsafe impl NSCopying for MLCEmbeddingDescriptor {}
21);
22
23unsafe impl CopyingHelper for MLCEmbeddingDescriptor {
24    type Result = Self;
25}
26
27extern_conformance!(
28    unsafe impl NSObjectProtocol for MLCEmbeddingDescriptor {}
29);
30
31impl MLCEmbeddingDescriptor {
32    extern_methods!(
33        #[deprecated]
34        #[unsafe(method(new))]
35        #[unsafe(method_family = new)]
36        pub unsafe fn new() -> Retained<Self>;
37
38        #[deprecated]
39        #[unsafe(method(init))]
40        #[unsafe(method_family = init)]
41        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
42
43        /// The size of the dictionary
44        #[deprecated]
45        #[unsafe(method(embeddingCount))]
46        #[unsafe(method_family = none)]
47        pub unsafe fn embeddingCount(&self) -> Retained<NSNumber>;
48
49        /// The dimension of embedding vectors
50        #[deprecated]
51        #[unsafe(method(embeddingDimension))]
52        #[unsafe(method_family = none)]
53        pub unsafe fn embeddingDimension(&self) -> Retained<NSNumber>;
54
55        /// If set, the embedding vector at paddingIndex is initialized with zero and will not be updated in gradient pass, Default=nil
56        #[deprecated]
57        #[unsafe(method(paddingIndex))]
58        #[unsafe(method_family = none)]
59        pub unsafe fn paddingIndex(&self) -> Option<Retained<NSNumber>>;
60
61        /// A float, if set, in the forward pass only, the selected embedding vectors will be re-normalized to have an Lp norm of less than maximumNorm in the dictionary, Default=nil
62        #[deprecated]
63        #[unsafe(method(maximumNorm))]
64        #[unsafe(method_family = none)]
65        pub unsafe fn maximumNorm(&self) -> Option<Retained<NSNumber>>;
66
67        /// A float, the p of the Lp norm, can be set to infinity norm by [NSNumber numberWithFloat:INFINITY]. Default=2.0
68        #[deprecated]
69        #[unsafe(method(pNorm))]
70        #[unsafe(method_family = none)]
71        pub unsafe fn pNorm(&self) -> Option<Retained<NSNumber>>;
72
73        /// If set, the gradients are scaled by the inverse of the frequency of the words in batch before the weight update. Default=NO
74        #[deprecated]
75        #[unsafe(method(scalesGradientByFrequency))]
76        #[unsafe(method_family = none)]
77        pub unsafe fn scalesGradientByFrequency(&self) -> bool;
78
79        #[deprecated]
80        #[unsafe(method(descriptorWithEmbeddingCount:embeddingDimension:))]
81        #[unsafe(method_family = none)]
82        pub unsafe fn descriptorWithEmbeddingCount_embeddingDimension(
83            embedding_count: &NSNumber,
84            embedding_dimension: &NSNumber,
85        ) -> Option<Retained<Self>>;
86
87        #[deprecated]
88        #[unsafe(method(descriptorWithEmbeddingCount:embeddingDimension:paddingIndex:maximumNorm:pNorm:scalesGradientByFrequency:))]
89        #[unsafe(method_family = none)]
90        pub unsafe fn descriptorWithEmbeddingCount_embeddingDimension_paddingIndex_maximumNorm_pNorm_scalesGradientByFrequency(
91            embedding_count: &NSNumber,
92            embedding_dimension: &NSNumber,
93            padding_index: Option<&NSNumber>,
94            maximum_norm: Option<&NSNumber>,
95            p_norm: Option<&NSNumber>,
96            scales_gradient_by_frequency: bool,
97        ) -> Option<Retained<Self>>;
98    );
99}
objc2_ml_compute/generated/MLCEmbeddingDescriptor.rs

objc2_ml_compute/generated/
MLCEmbeddingDescriptor.rs
