Struct MLCMultiheadAttentionDescriptor

Source

#[repr(C)]
pub struct MLCMultiheadAttentionDescriptor { /* private fields */ }

👎Deprecated

Available on crate feature MLCMultiheadAttentionDescriptor only.

Expand description

The MLCMultiheadAttentionDescriptor specifies a Multi-Head Attention descriptor

Implementations§

Source §

impl MLCMultiheadAttentionDescriptor

Source

pub unsafe fn new() -> Retained<Self>

👎Deprecated

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

👎Deprecated

Source

pub unsafe fn modelDimension(&self) -> NSUInteger

👎Deprecated

model or embedding dimension

Source

pub unsafe fn keyDimension(&self) -> NSUInteger

👎Deprecated

total dimension of key space, Default = modelDimension

Source

pub unsafe fn valueDimension(&self) -> NSUInteger

👎Deprecated

total dimension of value space, Default = modelDimension

Source

pub unsafe fn headCount(&self) -> NSUInteger

👎Deprecated

number of parallel attention heads

Source

pub unsafe fn dropout(&self) -> c_float

👎Deprecated

a droupout layer applied to the output projection weights. Default = 0.0

Source

pub unsafe fn hasBiases(&self) -> bool

👎Deprecated

if true, bias is used for query/key/value/output projections. Default = true

Source

pub unsafe fn hasAttentionBiases(&self) -> bool

👎Deprecated

if true, an array of biases is added to key and value respectively. Default = false

Source

pub unsafe fn addsZeroAttention(&self) -> bool

👎Deprecated

if true, a row of zeroes is added to projected key and value. Default = false

Source

pub unsafe fn descriptorWithModelDimension_keyDimension_valueDimension_headCount_dropout_hasBiases_hasAttentionBiases_addsZeroAttention( model_dimension: NSUInteger, key_dimension: NSUInteger, value_dimension: NSUInteger, head_count: NSUInteger, dropout: c_float, has_biases: bool, has_attention_biases: bool, adds_zero_attention: bool, ) -> Option<Retained<Self>>

👎Deprecated

A multi-head attention layer descriptor

Parameter modelDimension: total dimension of model space

Parameter keyDimension: total dimension of key space. Default = modelDimension

Parameter valueDimension: total dimension of value space. Default = modelDimension

Parameter headCount: number of parallel attention heads

Parameter dropout: optional, a dropout layer applied to the output projection weights. Default = 0.0f

Parameter hasBiases: if true, bias will be added to query/key/value/output projections. Default = YES

Parameter hasAttentionBiases: if true, an array of biases is added to key and value respectively. Default = NO

Parameter addsZeroAttention: if true, a row of zeroes is added to projected key and value. Default = NO

Returns: A new MultiheadAttention layer descriptor

Source

pub unsafe fn descriptorWithModelDimension_headCount( model_dimension: NSUInteger, head_count: NSUInteger, ) -> Retained<Self>

👎Deprecated

A multi-head attention layer descriptor

Parameter modelDimension: total dimension of model space

Parameter headCount: number of parallel attention heads

Returns: A valid MultiheadAttention layer descriptor

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use 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.

Source

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`
    }
}