Struct MPSGraphGRUDescriptor

Source

pub struct MPSGraphGRUDescriptor { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphRNNOps only.

Expand description

The class that defines the parameters for a gated recurrent unit (GRU) operation.

Use this descriptor with the following MPSGraph methods:

MPSGraph/GRUWithSourceTensor:recurrentWeight:inputWeight:bias:descriptor:name:
MPSGraph/GRUWithSourceTensor:recurrentWeight:inputWeight:bias:initState:descriptor:name:
MPSGraph/GRUWithSourceTensor:recurrentWeight:inputWeight:bias:initState:mask:secondaryBias:descriptor:name:
MPSGraph/GRUGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:outputFwd:inputWeight:bias:descriptor:name:
MPSGraph/GRUGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:outputFwd:inputWeight:bias:initState:descriptor:name:
MPSGraph/GRUGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:outputFwd:stateGradient:inputWeight:bias:initState:mask:secondaryBias:descriptor:name:

Implementations§

Source §

impl MPSGraphGRUDescriptor

Source

pub unsafe fn reverse(&self) -> bool

A parameter that defines the time direction of the input sequence.

If set to YES then the input sequence is passed in reverse time order to the layer. Note: Ignored when bidirectional = YES. Default value: NO.

Source

pub unsafe fn setReverse(&self, reverse: bool)

Setter for reverse.

Source

pub unsafe fn bidirectional(&self) -> bool

A parameter that defines a bidirectional GRU layer.

If set to YES then the input sequence is traversed in both directions and the two results are concatenated together on the channel-axis. Default value: NO.

Source

pub unsafe fn setBidirectional(&self, bidirectional: bool)

Setter for bidirectional.

Source

pub unsafe fn training(&self) -> bool

A parameter that enables the GRU layer to support training.

If set to YES then the layer will produce training state tensor as a secondary output. Default value: NO.

Source

pub unsafe fn setTraining(&self, training: bool)

Setter for training.

Source

pub unsafe fn resetGateFirst(&self) -> bool

A parameter that controls the internal order of the GRU gates.

If set to YES then the layer will use the gate-ordering [ r, z, o ] instead of default [ z, r, o ]. Default value: NO.

Source

pub unsafe fn setResetGateFirst(&self, reset_gate_first: bool)

Setter for resetGateFirst.

Source

pub unsafe fn resetAfter(&self) -> bool

A parameter that chooses between two variants for the reset gate computation.

If set to YES then the layer will compute the intermediate value as c[t] = ( b + (h[t-1] m ) R^T) r[t]. Otherwise it’s computed as c[t] = (h[t-1] r[t] m) R^T. Default value: NO.

Source

pub unsafe fn setResetAfter(&self, reset_after: bool)

Setter for resetAfter.

Source

pub unsafe fn flipZ(&self) -> bool

A parameter that chooses between two variants for the final output computation.

If set to YES then the layer will compute the final value as h[t] = z[t] h[t-1] + (1-z[t]) o[t]. Otherwise it’s computed as h[t] = (1-z[t]) h[t-1] + z[t] o[t]. Default value: NO.

Source

pub unsafe fn setFlipZ(&self, flip_z: bool)

Setter for flipZ.

Source

pub unsafe fn updateGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function to use with the update-gate of the GRU operation.

Default value: MPSGraphRNNActivationSigmoid.

Source

pub unsafe fn setUpdateGateActivation( &self, update_gate_activation: MPSGraphRNNActivation, )

Setter for updateGateActivation.

Source

pub unsafe fn resetGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function to use with the reset-gate of the GRU operation.

Default value: MPSGraphRNNActivationSigmoid.

Source

pub unsafe fn setResetGateActivation( &self, reset_gate_activation: MPSGraphRNNActivation, )

Setter for resetGateActivation.

Source

pub unsafe fn outputGateActivation(&self) -> MPSGraphRNNActivation

A parameter that defines the activation function to use with the output-gate of the GRU operation.

Default value: MPSGraphRNNActivationTanh.

Source

pub unsafe fn setOutputGateActivation( &self, output_gate_activation: MPSGraphRNNActivation, )

Setter for outputGateActivation.

Source

pub unsafe fn descriptor() -> Option<Retained<Self>>

Creates an GRU descriptor with default values.

Source §

impl MPSGraphGRUDescriptor

Methods declared on superclass NSObject.

Source

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

Source

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

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