#[repr(C)]pub struct MLCEmbeddingDescriptor { /* private fields */ }
MLCEmbeddingDescriptor
only.Expand description
The MLCEmbeddingDescriptor specifies an embedding layer descriptor
See also Appleโs documentation
Implementationsยง
Sourceยงimpl MLCEmbeddingDescriptor
impl MLCEmbeddingDescriptor
pub unsafe fn new() -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Sourcepub unsafe fn embeddingCount(&self) -> Retained<NSNumber>
๐Deprecated
pub unsafe fn embeddingCount(&self) -> Retained<NSNumber>
The size of the dictionary
Sourcepub unsafe fn embeddingDimension(&self) -> Retained<NSNumber>
๐Deprecated
pub unsafe fn embeddingDimension(&self) -> Retained<NSNumber>
The dimension of embedding vectors
Sourcepub unsafe fn paddingIndex(&self) -> Option<Retained<NSNumber>>
๐Deprecated
pub unsafe fn paddingIndex(&self) -> Option<Retained<NSNumber>>
If set, the embedding vector at paddingIndex is initialized with zero and will not be updated in gradient pass, Default=nil
Sourcepub unsafe fn maximumNorm(&self) -> Option<Retained<NSNumber>>
๐Deprecated
pub unsafe fn maximumNorm(&self) -> Option<Retained<NSNumber>>
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
Sourcepub unsafe fn pNorm(&self) -> Option<Retained<NSNumber>>
๐Deprecated
pub unsafe fn pNorm(&self) -> Option<Retained<NSNumber>>
A float, the p of the Lp norm, can be set to infinity norm by [NSNumber numberWithFloat:INFINITY]. Default=2.0
Sourcepub unsafe fn scalesGradientByFrequency(&self) -> bool
๐Deprecated
pub unsafe fn scalesGradientByFrequency(&self) -> bool
If set, the gradients are scaled by the inverse of the frequency of the words in batch before the weight update. Default=NO
pub unsafe fn descriptorWithEmbeddingCount_embeddingDimension( embedding_count: &NSNumber, embedding_dimension: &NSNumber, ) -> Option<Retained<Self>>
pub unsafe fn descriptorWithEmbeddingCount_embeddingDimension_paddingIndex_maximumNorm_pNorm_scalesGradientByFrequency( embedding_count: &NSNumber, embedding_dimension: &NSNumber, padding_index: Option<&NSNumber>, maximum_norm: Option<&NSNumber>, p_norm: Option<&NSNumber>, scales_gradient_by_frequency: bool, ) -> Option<Retained<Self>>
Methods from Deref<Target = NSObject>ยง
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesnโt recognize.
See Appleโs documentation for details.
Methods from Deref<Target = AnyObject>ยง
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
ยงPanics
May panic if the object is invalid (which may be the case for objects
returned from unavailable init
/new
methods).
ยงExample
Check that an instance of NSObject
has the precise class NSObject
.
use objc2::ClassType;
use objc2::runtime::NSObject;
let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
๐Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.Use Ivar::load
instead.
ยงSafety
The object must have an instance variable with the given name, and it
must be of type T
.
See Ivar::load_ptr
for details surrounding this.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Attempt to downcast the object to a class of type T
.
This is the reference-variant. Use Retained::downcast
if you want
to convert a retained object to another type.
ยงMutable classes
Some classes have immutable and mutable variants, such as NSString
and NSMutableString
.
When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable โunder the hoodโ.
So using this method to convert a NSString
to a NSMutableString
,
while not unsound, is generally frowned upon unless you created the
string yourself, or the API explicitly documents the string to be
mutable.
See Appleโs documentation on mutability and on
isKindOfClass:
for more details.
ยงGeneric classes
Objective-C generics are called โlightweight genericsโ, and thatโs because they arenโt exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.
You can, however, safely downcast to generic collections where all the
type-parameters are AnyObject
.
ยงPanics
This works internally by calling isKindOfClass:
. That means that the
object must have the instance method of that name, and an exception
will be thrown (if CoreFoundation is linked) or the process will abort
if that is not the case. In the vast majority of cases, you donโt need
to worry about this, since both root objects NSObject
and
NSProxy
implement this method.
ยงExamples
Cast an NSString
back and forth from NSObject
.
use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};
let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();
Try (and fail) to cast an NSObject
to an NSString
.
use objc2_foundation::{NSObject, NSString};
let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());
Try to cast to an array of strings.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();
This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.
Downcast when processing each element instead.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
for elem in arr {
if let Some(data) = elem.downcast_ref::<NSString>() {
// handle `data`
}
}
Trait Implementationsยง
Sourceยงimpl AsRef<AnyObject> for MLCEmbeddingDescriptor
impl AsRef<AnyObject> for MLCEmbeddingDescriptor
Sourceยงimpl AsRef<NSObject> for MLCEmbeddingDescriptor
impl AsRef<NSObject> for MLCEmbeddingDescriptor
Sourceยงimpl Borrow<AnyObject> for MLCEmbeddingDescriptor
impl Borrow<AnyObject> for MLCEmbeddingDescriptor
Sourceยงimpl Borrow<NSObject> for MLCEmbeddingDescriptor
impl Borrow<NSObject> for MLCEmbeddingDescriptor
Sourceยงimpl ClassType for MLCEmbeddingDescriptor
impl ClassType for MLCEmbeddingDescriptor
Sourceยงconst NAME: &'static str = "MLCEmbeddingDescriptor"
const NAME: &'static str = "MLCEmbeddingDescriptor"
Sourceยงtype ThreadKind = <<MLCEmbeddingDescriptor as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<MLCEmbeddingDescriptor as ClassType>::Super as ClassType>::ThreadKind
Sourceยงimpl CopyingHelper for MLCEmbeddingDescriptor
impl CopyingHelper for MLCEmbeddingDescriptor
Sourceยงtype Result = MLCEmbeddingDescriptor
type Result = MLCEmbeddingDescriptor
Self
if the type has no
immutable counterpart. Read moreSourceยงimpl Debug for MLCEmbeddingDescriptor
impl Debug for MLCEmbeddingDescriptor
Sourceยงimpl Deref for MLCEmbeddingDescriptor
impl Deref for MLCEmbeddingDescriptor
Sourceยงimpl Hash for MLCEmbeddingDescriptor
impl Hash for MLCEmbeddingDescriptor
Sourceยงimpl Message for MLCEmbeddingDescriptor
impl Message for MLCEmbeddingDescriptor
Sourceยงimpl NSCopying for MLCEmbeddingDescriptor
impl NSCopying for MLCEmbeddingDescriptor
Sourceยงimpl NSObjectProtocol for MLCEmbeddingDescriptor
impl NSObjectProtocol for MLCEmbeddingDescriptor
Sourceยงfn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Sourceยงfn hash(&self) -> usize
fn hash(&self) -> usize
Sourceยงfn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Sourceยงfn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref