Struct MPSGraphExecutable

Source

pub struct MPSGraphExecutable { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphExecutable only.

Expand description

The compiled representation of a compute graph executable.

An MPSGraphExecutable is a compiled graph for specific feeds for specific target tensors and target operations.

Implementations§

Source §

impl MPSGraphExecutable

Source

pub unsafe fn options(&self) -> MPSGraphOptions

Available on crate feature MPSGraph only.

Options for the graph executable.

Default value is MPSGraphOptionsDefault.

Source

pub unsafe fn setOptions(&self, options: MPSGraphOptions)

Available on crate feature MPSGraph only.

Setter for options.

Source

pub unsafe fn feedTensors(&self) -> Option<Retained<NSArray<MPSGraphTensor>>>

Available on crate feature MPSGraphTensor only.

Tensors fed to the graph, can be used to order the inputs when executable is created with a graph.

Source

pub unsafe fn targetTensors(&self) -> Option<Retained<NSArray<MPSGraphTensor>>>

Available on crate feature MPSGraphTensor only.

Tensors targeted by the graph, can be used to order the outputs when executable was created with a graph.

Source

pub unsafe fn specializeWithDevice_inputTypes_compilationDescriptor( &self, device: Option<&MPSGraphDevice>, input_types: &NSArray<MPSGraphType>, compilation_descriptor: Option<&MPSGraphCompilationDescriptor>, )

Available on crate features MPSGraph and MPSGraphDevice only.

Specialize the executable and optimize it.

Use this method to choose when specialization happens, else it occurs at encode time automatically.

Parameters:
device:Ooptional MPSGraph device to compile with.
inputTypes: Input types expected to be passed to the executable.
compilationDescriptor: Compilation descriptor to be used to specialize, since the executable was created with a compilationDescriptor already this one overrides those settings to the extent it can.

Source

pub unsafe fn getOutputTypesWithDevice_inputTypes_compilationDescriptor( &self, device: Option<&MPSGraphDevice>, input_types: &NSArray<MPSGraphType>, compilation_descriptor: Option<&MPSGraphCompilationDescriptor>, ) -> Option<Retained<NSArray<MPSGraphShapedType>>>

Available on crate features MPSGraph and MPSGraphDevice only.

Get output shapes for a specialized executable.

In case specialization has not been done yet then calling this function will specialize for the given input shapes.

Parameters:
device: Optional MPSGraph device to compile with
inputTypes: Input types expected to be passed to the executable.
compilationDescriptor: CompilationDescriptor to be used to specialize, since the executable was created with a compilationDescriptor already this one overrides those settings to the extent it can.

Source

pub unsafe fn runWithMTLCommandQueue_inputsArray_resultsArray_executionDescriptor( &self, command_queue: &ProtocolObject<dyn MTLCommandQueue>, inputs_array: &NSArray<MPSGraphTensorData>, results_array: Option<&NSArray<MPSGraphTensorData>>, execution_descriptor: Option<&MPSGraphExecutableExecutionDescriptor>, ) -> Retained<NSArray<MPSGraphTensorData>>

Available on crate feature MPSGraphTensorData only.

Runs the graph for the given feeds and returns the target tensor values, ensuring all target operations also executed.

This call is synchronous and will return on completion of execution.

Parameters:
commandQueue: CommandQueue passed to exectute the graph on.
inputsArray: Feeds tensorData for the placeholder tensors, same order as arguments of main function.
resultsArray: Results tensorData for which the caller wishes MPSGraphTensorData to be returned.
Returns: A valid MPSGraphTensorData array with results synchronized to the CPU memory if MPSGraphOptionsSynchronizeResults set.

Source

pub unsafe fn runAsyncWithMTLCommandQueue_inputsArray_resultsArray_executionDescriptor( &self, command_queue: &ProtocolObject<dyn MTLCommandQueue>, inputs_array: &NSArray<MPSGraphTensorData>, results_array: Option<&NSArray<MPSGraphTensorData>>, execution_descriptor: Option<&MPSGraphExecutableExecutionDescriptor>, ) -> Retained<NSArray<MPSGraphTensorData>>

Available on crate feature MPSGraphTensorData only.

Runs the graph for the given feeds and returns the target tensor values, ensuring all target operations also executed. This call is asynchronous and will return immediately.

Parameters:
commandQueue: CommandQueue passed to exectute the graph on.
inputsArray: Feeds tensorData for the placeholder tensors, same order as arguments of main function.
resultsArray: Tensors for which the caller wishes MPSGraphTensorData to be returned.
executionDescriptor: ExecutionDescriptor to be passed in and used.
Returns: A valid MPSGraphTensorData array with results synchronized to the CPU memory if MPSGraphOptionsSynchronizeResults set.

Source

pub unsafe fn encodeToCommandBuffer_inputsArray_resultsArray_executionDescriptor( &self, command_buffer: &MPSCommandBuffer, inputs_array: &NSArray<MPSGraphTensorData>, results_array: Option<&NSArray<MPSGraphTensorData>>, execution_descriptor: Option<&MPSGraphExecutableExecutionDescriptor>, ) -> Retained<NSArray<MPSGraphTensorData>>

Available on crate features MPSGraphTensorData and objc2-metal-performance-shaders only.

Runs the graph for the given feeds and returns the target tensor values, ensuring all target operations also executed. This call is asynchronous and will return immediately after finishing encoding.

Parameters:
commandBuffer: CommandBuffer passed to exectute the graph on, commitAndContinue might be called, please don’t rely on underlying MTLCommandBuffer to remain uncommitted
inputsArray: Feeds tensorData for the placeholder tensors, same order as arguments of main function
resultsArray: Tensors for which the caller wishes MPSGraphTensorData to be returned
executionDescriptor: ExecutionDescriptor to be passed in and used,
Returns: A valid MPSGraphTensorData array with results synchronized to the CPU memory if MPSGraphOptionsSynchronizeResults set.

Source

pub unsafe fn serializeToMPSGraphPackageAtURL_descriptor( &self, url: &NSURL, descriptor: Option<&MPSGraphExecutableSerializationDescriptor>, )

Serialize the MPSGraph executable at the provided url.

Parameters:
url: The URL where to serialize the MPSGraph executable.
descriptor: The descriptor to be used to serialize the graph.

Source

pub unsafe fn initWithMPSGraphPackageAtURL_compilationDescriptor( this: Allocated<Self>, mpsgraph_package_url: &NSURL, compilation_descriptor: Option<&MPSGraphCompilationDescriptor>, ) -> Retained<Self>

Available on crate feature MPSGraph only.

Initialize the executable with the Metal Performance Shaders Graph package at the provided URL.

Parameters:
mpsgraphPackageURL: The URL where to read the serialized MPSGraphExecutable.
compilationDescriptor: Compilation descriptor to be used to specialize, since the executable was created with a compilationDescriptor already this one overrides those settings to the extent it can.

Source

pub unsafe fn initWithCoreMLPackageAtURL_compilationDescriptor( this: Allocated<Self>, core_ml_package_url: &NSURL, compilation_descriptor: Option<&MPSGraphCompilationDescriptor>, ) -> Retained<Self>

Available on crate feature MPSGraph only.

Initialize the executable with the Core ML model package at the provided URL.

Parameters:
coreMLPackageURL: The URL where to read the Core ML model package.
compilationDescriptor: Compilation descriptor to be used to specialize, since the executable was created with a compilationDescriptor already this one overrides those settings to the extent it can.

Source §

impl MPSGraphExecutable

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