Struct MLModelDescription

Source

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

Available on crate feature MLModelDescription only.

Expand description

A description of a model containing input, output, and state feature descriptions, optionally outputted features with special meaning and metadata.

Implementations§

Source §

impl MLModelDescription

Source

pub unsafe fn inputDescriptionsByName( &self, ) -> Retained<NSDictionary<NSString, MLFeatureDescription>>

Available on crate feature MLFeatureDescription only.

Description of the inputs to the model

Source

pub unsafe fn outputDescriptionsByName( &self, ) -> Retained<NSDictionary<NSString, MLFeatureDescription>>

Available on crate feature MLFeatureDescription only.

Description of the outputs from the model

Source

pub unsafe fn stateDescriptionsByName( &self, ) -> Retained<NSDictionary<NSString, MLFeatureDescription>>

Available on crate feature MLFeatureDescription only.

Description of the state features.

Source

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

Name of the primary target / predicted output feature in the output descriptions

Source

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

Key for all predicted probabilities stored as a MLFeatureTypeDictionary in the output descriptions

Source

pub unsafe fn metadata( &self, ) -> Retained<NSDictionary<MLModelMetadataKey, AnyObject>>

Available on crate feature MLModelMetadataKeys only.

Optional metadata describing the model

Source

pub unsafe fn classLabels(&self) -> Option<Retained<NSArray<AnyObject>>>

Array to map a class index to the corresponding label, which is either Number or String.

The property is populated from the classLabels entry specified in the model’s protobuf message. When the model is a pipeline, which contains one or more sub models, the property value is calculated as follows.

If the pipeline model’s proto message specifies predictedFeatureName parameter, use classLabels property value of the sub model with the output feature with the name.
Otherwise, if the pipeline model has only one sub model with non-nil classLabels property, use the property value.
Otherwise, the property is nil.

Source §

impl MLModelDescription

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl MLModelDescription

MLUpdateAdditions. Additions to model descriptions related to model update API.

Source

pub unsafe fn isUpdatable(&self) -> bool

Source

pub unsafe fn trainingInputDescriptionsByName( &self, ) -> Retained<NSDictionary<NSString, MLFeatureDescription>>

Available on crate feature MLFeatureDescription only.

Source §

impl MLModelDescription

MLParameters. Additions to model descriptions related to model parameters

Source

pub unsafe fn parameterDescriptionsByKey( &self, ) -> Retained<NSDictionary<MLParameterKey, MLParameterDescription>>

Available on crate features MLKey and MLParameterDescription and MLParameterKey only.

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