#[repr(C)]pub struct MLCLayer { /* private fields */ }
MLCLayer
only.Expand description
The base class for all MLCompute layers
There are as many MLCLayer subclasses as there are MLCompute neural network layer objects. Make one of those. This class defines an polymorphic interface for them.
See also Appleโs documentation
Implementationsยง
Sourceยงimpl MLCLayer
impl MLCLayer
Sourcepub unsafe fn layerID(&self) -> NSUInteger
๐Deprecated
pub unsafe fn layerID(&self) -> NSUInteger
The layer ID
A unique number to identify each layer. Assigned when the layer is created.
Sourcepub unsafe fn label(&self) -> Retained<NSString>
๐Deprecated
pub unsafe fn label(&self) -> Retained<NSString>
A string to help identify this object.
Sourcepub unsafe fn isDebuggingEnabled(&self) -> bool
๐Deprecated
pub unsafe fn isDebuggingEnabled(&self) -> bool
A flag to identify if we want to debug this layer when executing a graph that includes this layer
If this is set, we will make sure that the result tensor and gradient tensors are available for reading on CPU The default is NO. If isDebuggingEnabled is set to YES, make sure to set options to enable debugging when compiling the graph. Otherwise this property may be ignored.
Sourcepub unsafe fn setIsDebuggingEnabled(&self, is_debugging_enabled: bool)
๐Deprecated
pub unsafe fn setIsDebuggingEnabled(&self, is_debugging_enabled: bool)
Setter for isDebuggingEnabled
.
Sourcepub unsafe fn supportsDataType_onDevice(
data_type: MLCDataType,
device: &MLCDevice,
) -> bool
๐DeprecatedAvailable on crate features MLCDevice
and MLCTypes
only.
pub unsafe fn supportsDataType_onDevice( data_type: MLCDataType, device: &MLCDevice, ) -> bool
MLCDevice
and MLCTypes
only.Determine whether instances of this layer accept source tensors of the given data type on the given device.
Parameter dataType
: A data type of a possible input tensor to the layer
Parameter device
: A device
Returns: A boolean indicating whether the data type is supported
Sourcepub unsafe fn deviceType(&self) -> MLCDeviceType
Available on crate feature MLCTypes
only.
pub unsafe fn deviceType(&self) -> MLCDeviceType
MLCTypes
only.The device type where this layer will be executed
Typically the MLCDevice passed to compileWithOptions will be the device used to execute layers in the graph. If MLCDeviceTypeANE is selected, it is possible that some of the layers of the graph may not be executed on the ANE but instead on the CPU or GPU. This property can be used to determine which device type the layer will be executed on.
pub unsafe fn new() -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> 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<MLCLayer> for MLCActivationLayer
Available on crate feature MLCActivationLayer
only.
impl AsRef<MLCLayer> for MLCActivationLayer
MLCActivationLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCArithmeticLayer
Available on crate feature MLCArithmeticLayer
only.
impl AsRef<MLCLayer> for MLCArithmeticLayer
MLCArithmeticLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCBatchNormalizationLayer
Available on crate feature MLCBatchNormalizationLayer
only.
impl AsRef<MLCLayer> for MLCBatchNormalizationLayer
MLCBatchNormalizationLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCComparisonLayer
Available on crate feature MLCComparisonLayer
only.
impl AsRef<MLCLayer> for MLCComparisonLayer
MLCComparisonLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCConcatenationLayer
Available on crate feature MLCConcatenationLayer
only.
impl AsRef<MLCLayer> for MLCConcatenationLayer
MLCConcatenationLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCConvolutionLayer
Available on crate feature MLCConvolutionLayer
only.
impl AsRef<MLCLayer> for MLCConvolutionLayer
MLCConvolutionLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCDropoutLayer
Available on crate feature MLCDropoutLayer
only.
impl AsRef<MLCLayer> for MLCDropoutLayer
MLCDropoutLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCEmbeddingLayer
Available on crate feature MLCEmbeddingLayer
only.
impl AsRef<MLCLayer> for MLCEmbeddingLayer
MLCEmbeddingLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCFullyConnectedLayer
Available on crate feature MLCFullyConnectedLayer
only.
impl AsRef<MLCLayer> for MLCFullyConnectedLayer
MLCFullyConnectedLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCGatherLayer
Available on crate feature MLCGatherLayer
only.
impl AsRef<MLCLayer> for MLCGatherLayer
MLCGatherLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCGramMatrixLayer
Available on crate feature MLCGramMatrixLayer
only.
impl AsRef<MLCLayer> for MLCGramMatrixLayer
MLCGramMatrixLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCGroupNormalizationLayer
Available on crate feature MLCGroupNormalizationLayer
only.
impl AsRef<MLCLayer> for MLCGroupNormalizationLayer
MLCGroupNormalizationLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCInstanceNormalizationLayer
Available on crate feature MLCInstanceNormalizationLayer
only.
impl AsRef<MLCLayer> for MLCInstanceNormalizationLayer
MLCInstanceNormalizationLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCLSTMLayer
Available on crate feature MLCLSTMLayer
only.
impl AsRef<MLCLayer> for MLCLSTMLayer
MLCLSTMLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCLayerNormalizationLayer
Available on crate feature MLCLayerNormalizationLayer
only.
impl AsRef<MLCLayer> for MLCLayerNormalizationLayer
MLCLayerNormalizationLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCLossLayer
Available on crate feature MLCLossLayer
only.
impl AsRef<MLCLayer> for MLCLossLayer
MLCLossLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCMatMulLayer
Available on crate feature MLCMatMulLayer
only.
impl AsRef<MLCLayer> for MLCMatMulLayer
MLCMatMulLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCMultiheadAttentionLayer
Available on crate feature MLCMultiheadAttentionLayer
only.
impl AsRef<MLCLayer> for MLCMultiheadAttentionLayer
MLCMultiheadAttentionLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCPaddingLayer
Available on crate feature MLCPaddingLayer
only.
impl AsRef<MLCLayer> for MLCPaddingLayer
MLCPaddingLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCPoolingLayer
Available on crate feature MLCPoolingLayer
only.
impl AsRef<MLCLayer> for MLCPoolingLayer
MLCPoolingLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCReductionLayer
Available on crate feature MLCReductionLayer
only.
impl AsRef<MLCLayer> for MLCReductionLayer
MLCReductionLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCReshapeLayer
Available on crate feature MLCReshapeLayer
only.
impl AsRef<MLCLayer> for MLCReshapeLayer
MLCReshapeLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCScatterLayer
Available on crate feature MLCScatterLayer
only.
impl AsRef<MLCLayer> for MLCScatterLayer
MLCScatterLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCSelectionLayer
Available on crate feature MLCSelectionLayer
only.
impl AsRef<MLCLayer> for MLCSelectionLayer
MLCSelectionLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCSliceLayer
Available on crate feature MLCSliceLayer
only.
impl AsRef<MLCLayer> for MLCSliceLayer
MLCSliceLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCSoftmaxLayer
Available on crate feature MLCSoftmaxLayer
only.
impl AsRef<MLCLayer> for MLCSoftmaxLayer
MLCSoftmaxLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCSplitLayer
Available on crate feature MLCSplitLayer
only.
impl AsRef<MLCLayer> for MLCSplitLayer
MLCSplitLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCTransposeLayer
Available on crate feature MLCTransposeLayer
only.
impl AsRef<MLCLayer> for MLCTransposeLayer
MLCTransposeLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCUpsampleLayer
Available on crate feature MLCUpsampleLayer
only.
impl AsRef<MLCLayer> for MLCUpsampleLayer
MLCUpsampleLayer
only.Sourceยงimpl AsRef<MLCLayer> for MLCYOLOLossLayer
Available on crate features MLCLossLayer
and MLCYOLOLossLayer
only.
impl AsRef<MLCLayer> for MLCYOLOLossLayer
MLCLossLayer
and MLCYOLOLossLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCActivationLayer
Available on crate feature MLCActivationLayer
only.
impl Borrow<MLCLayer> for MLCActivationLayer
MLCActivationLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCArithmeticLayer
Available on crate feature MLCArithmeticLayer
only.
impl Borrow<MLCLayer> for MLCArithmeticLayer
MLCArithmeticLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCBatchNormalizationLayer
Available on crate feature MLCBatchNormalizationLayer
only.
impl Borrow<MLCLayer> for MLCBatchNormalizationLayer
MLCBatchNormalizationLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCComparisonLayer
Available on crate feature MLCComparisonLayer
only.
impl Borrow<MLCLayer> for MLCComparisonLayer
MLCComparisonLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCConcatenationLayer
Available on crate feature MLCConcatenationLayer
only.
impl Borrow<MLCLayer> for MLCConcatenationLayer
MLCConcatenationLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCConvolutionLayer
Available on crate feature MLCConvolutionLayer
only.
impl Borrow<MLCLayer> for MLCConvolutionLayer
MLCConvolutionLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCDropoutLayer
Available on crate feature MLCDropoutLayer
only.
impl Borrow<MLCLayer> for MLCDropoutLayer
MLCDropoutLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCEmbeddingLayer
Available on crate feature MLCEmbeddingLayer
only.
impl Borrow<MLCLayer> for MLCEmbeddingLayer
MLCEmbeddingLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCFullyConnectedLayer
Available on crate feature MLCFullyConnectedLayer
only.
impl Borrow<MLCLayer> for MLCFullyConnectedLayer
MLCFullyConnectedLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCGatherLayer
Available on crate feature MLCGatherLayer
only.
impl Borrow<MLCLayer> for MLCGatherLayer
MLCGatherLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCGramMatrixLayer
Available on crate feature MLCGramMatrixLayer
only.
impl Borrow<MLCLayer> for MLCGramMatrixLayer
MLCGramMatrixLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCGroupNormalizationLayer
Available on crate feature MLCGroupNormalizationLayer
only.
impl Borrow<MLCLayer> for MLCGroupNormalizationLayer
MLCGroupNormalizationLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCInstanceNormalizationLayer
Available on crate feature MLCInstanceNormalizationLayer
only.
impl Borrow<MLCLayer> for MLCInstanceNormalizationLayer
MLCInstanceNormalizationLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCLSTMLayer
Available on crate feature MLCLSTMLayer
only.
impl Borrow<MLCLayer> for MLCLSTMLayer
MLCLSTMLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCLayerNormalizationLayer
Available on crate feature MLCLayerNormalizationLayer
only.
impl Borrow<MLCLayer> for MLCLayerNormalizationLayer
MLCLayerNormalizationLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCLossLayer
Available on crate feature MLCLossLayer
only.
impl Borrow<MLCLayer> for MLCLossLayer
MLCLossLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCMatMulLayer
Available on crate feature MLCMatMulLayer
only.
impl Borrow<MLCLayer> for MLCMatMulLayer
MLCMatMulLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCMultiheadAttentionLayer
Available on crate feature MLCMultiheadAttentionLayer
only.
impl Borrow<MLCLayer> for MLCMultiheadAttentionLayer
MLCMultiheadAttentionLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCPaddingLayer
Available on crate feature MLCPaddingLayer
only.
impl Borrow<MLCLayer> for MLCPaddingLayer
MLCPaddingLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCPoolingLayer
Available on crate feature MLCPoolingLayer
only.
impl Borrow<MLCLayer> for MLCPoolingLayer
MLCPoolingLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCReductionLayer
Available on crate feature MLCReductionLayer
only.
impl Borrow<MLCLayer> for MLCReductionLayer
MLCReductionLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCReshapeLayer
Available on crate feature MLCReshapeLayer
only.
impl Borrow<MLCLayer> for MLCReshapeLayer
MLCReshapeLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCScatterLayer
Available on crate feature MLCScatterLayer
only.
impl Borrow<MLCLayer> for MLCScatterLayer
MLCScatterLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCSelectionLayer
Available on crate feature MLCSelectionLayer
only.
impl Borrow<MLCLayer> for MLCSelectionLayer
MLCSelectionLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCSliceLayer
Available on crate feature MLCSliceLayer
only.
impl Borrow<MLCLayer> for MLCSliceLayer
MLCSliceLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCSoftmaxLayer
Available on crate feature MLCSoftmaxLayer
only.
impl Borrow<MLCLayer> for MLCSoftmaxLayer
MLCSoftmaxLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCSplitLayer
Available on crate feature MLCSplitLayer
only.
impl Borrow<MLCLayer> for MLCSplitLayer
MLCSplitLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCTransposeLayer
Available on crate feature MLCTransposeLayer
only.
impl Borrow<MLCLayer> for MLCTransposeLayer
MLCTransposeLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCUpsampleLayer
Available on crate feature MLCUpsampleLayer
only.
impl Borrow<MLCLayer> for MLCUpsampleLayer
MLCUpsampleLayer
only.Sourceยงimpl Borrow<MLCLayer> for MLCYOLOLossLayer
Available on crate features MLCLossLayer
and MLCYOLOLossLayer
only.
impl Borrow<MLCLayer> for MLCYOLOLossLayer
MLCLossLayer
and MLCYOLOLossLayer
only.Sourceยงimpl ClassType for MLCLayer
impl ClassType for MLCLayer
Sourceยงconst NAME: &'static str = "MLCLayer"
const NAME: &'static str = "MLCLayer"
Sourceยงtype ThreadKind = <<MLCLayer as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<MLCLayer as ClassType>::Super as ClassType>::ThreadKind
Sourceยงimpl NSObjectProtocol for MLCLayer
impl NSObjectProtocol for MLCLayer
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