Struct MLModelConfiguration

Source

pub struct MLModelConfiguration { /* private fields */ }

Available on crate feature MLModelConfiguration only.

Expand description

An object to hold options for loading a model.

Implementations§

Source §

impl MLModelConfiguration

Source

pub unsafe fn modelDisplayName(&self) -> Option<Retained<NSString>>

A human readable name of a MLModel instance for display purposes.

Use this property to set a name of a model instance so that runtime analysis tools (e.g. Instruments and os_log) can display that name in the user interface.

CoreML framework doesn’t parse nor filter the text. It is the client’s responsibility to use appropriate text, which may involve localization and privacy considerations.

When the property is nil, CoreML framework provides a default.

Source

pub unsafe fn setModelDisplayName(&self, model_display_name: Option<&NSString>)

Setter for modelDisplayName.

This is copied when set.

Source

pub unsafe fn computeUnits(&self) -> MLComputeUnits

Source

pub unsafe fn setComputeUnits(&self, compute_units: MLComputeUnits)

Setter for computeUnits.

Source

pub unsafe fn optimizationHints(&self) -> Retained<MLOptimizationHints>

Available on crate feature MLOptimizationHints only.

A group of hints for CoreML to optimize

Source

pub unsafe fn setOptimizationHints( &self, optimization_hints: &MLOptimizationHints, )

Available on crate feature MLOptimizationHints only.

Setter for optimizationHints.

This is copied when set.

Source §

impl MLModelConfiguration

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl MLModelConfiguration

MLGPUConfigurationOptions.

Allows app to specify GPU configuration options

Source

pub unsafe fn allowLowPrecisionAccumulationOnGPU(&self) -> bool

Set to YES to allow low precision accumulation on GPU when available. Defaults to NO

Source

pub unsafe fn setAllowLowPrecisionAccumulationOnGPU( &self, allow_low_precision_accumulation_on_gpu: bool, )

Setter for allowLowPrecisionAccumulationOnGPU.

Source

pub unsafe fn preferredMetalDevice( &self, ) -> Option<Retained<ProtocolObject<dyn MTLDevice>>>

Available on crate feature objc2-metal and non-watchOS only.

Set to specify a preferred Metal device. Defaults to nil which indicates automatic selection

Source

pub unsafe fn setPreferredMetalDevice( &self, preferred_metal_device: Option<&ProtocolObject<dyn MTLDevice>>, )

Available on crate feature objc2-metal and non-watchOS only.

Setter for preferredMetalDevice.

Source §

impl MLModelConfiguration

MLModelParameterAdditions.

Allows app to set model or update parameters as a dictionary.

Source

pub unsafe fn parameters( &self, ) -> Option<Retained<NSDictionary<MLParameterKey, AnyObject>>>

Available on crate features MLKey and MLParameterKey only.

Source

pub unsafe fn setParameters( &self, parameters: Option<&NSDictionary<MLParameterKey, AnyObject>>, )

Available on crate features MLKey and MLParameterKey only.

Setter for parameters.

§Safety

parameters generic should be of the correct type.

Source §

impl MLModelConfiguration

MultiFunctions.

Source

pub unsafe fn functionName(&self) -> Option<Retained<NSString>>

Function name that MLModel will use.

Some model types (e.g. ML Program) supports multiple functions in a model asset, where each MLModel instance is associated with a particular function.

Use MLModelAsset to get the list of available functions. Use nil to use a default function.

let configuration = MLModelConfiguration()
configuration.functionName = "my_function"

Source

pub unsafe fn setFunctionName(&self, function_name: Option<&NSString>)

Setter for functionName.

This is copied when set.

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