Expand description
§Bindings to the CoreML
framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- MLArray
Batch Provider MLArrayBatchProvider
- A concrete convenience class conforming to MLBatchProvider.
- MLCPU
Compute Device MLCPUComputeDevice
- Represents a CPU compute device.
- MLCompute
Plan MLComputePlan
- A class describing the plan for executing a model.
- MLCompute
Plan Cost MLComputePlanCost
- A class representing the estimated cost of executing a layer/operation.
- MLCompute
Plan Device Usage MLComputePlanDeviceUsage
- The anticipated compute devices that would be used for executing a layer/operation.
- MLCompute
Units MLModelConfiguration
- Apple’s documentation
- MLDictionary
Constraint MLDictionaryConstraint
- MLDictionaryConstraint
- MLDictionary
Feature Provider MLDictionaryFeatureProvider
- A concrete convenience class conforming to MLFeatureProvider.
- MLFeature
Description MLFeatureDescription
- Description of a feature
- MLFeature
Type MLFeatureType
- Supported data type enumeration
- MLFeature
Value MLFeatureValue
- An immutable variant holding a data value of a supported MLFeatureType
- MLGPU
Compute Device MLGPUComputeDevice
- Represents a GPU compute device.
- MLImage
Constraint MLImageConstraint
- MLImageConstraint
- MLImage
Size MLImageSize
- Apple’s documentation
- MLImage
Size Constraint MLImageSizeConstraint
- Apple’s documentation
- MLImage
Size Constraint Type MLImageSizeConstraintType
- Apple’s documentation
- MLKey
MLKey
- A class representing key used to store any value against
- MLMetric
Key MLKey
andMLMetricKey
- A class to specify list of supported model update metrics.
- MLModel
MLModel
- MLModel
- MLModel
Asset MLModelAsset
- A compiled model asset.
- MLModel
Collection Deprecated MLModelCollection
- MLModelCollection
- MLModel
Collection Entry Deprecated MLModelCollectionEntry
- MLModelCollectionEntry Information about a model in a model collection.
- MLModel
Configuration MLModelConfiguration
- An object to hold options for loading a model.
- MLModel
Description MLModelDescription
- A description of a model containing input, output, and state feature descriptions, optionally outputted features with special meaning and metadata.
- MLModel
Error MLModelError
- MLModelError defines the set of MLModel related error codes.
- MLModel
Structure MLModelStructure
- A class representing the structure of a model.
- MLModel
Structure Neural Network MLModelStructureNeuralNetwork
- A class representing the structure of a NeuralNetwork model.
- MLModel
Structure Neural Network Layer MLModelStructureNeuralNetworkLayer
- A class representing a layer in a NeuralNetwork.
- MLModel
Structure Pipeline MLModelStructurePipeline
- A class representing the structure of a Pipeline model.
- MLModel
Structure Program MLModelStructureProgram
- A class representing the structure of an ML Program model.
- MLModel
Structure Program Argument MLModelStructureProgramArgument
- A class representing an argument in the Program.
- MLModel
Structure Program Binding MLModelStructureProgramBinding
- A class representing a binding in the Program
- MLModel
Structure Program Block MLModelStructureProgramBlock
- A class representing a block in the Program.
- MLModel
Structure Program Function MLModelStructureProgramFunction
- A class representing a function in the Program.
- MLModel
Structure Program Named Value Type MLModelStructureProgramNamedValueType
- A class representing a named value type in a Program.
- MLModel
Structure Program Operation MLModelStructureProgramOperation
- A class representing an Operation in a Program.
- MLModel
Structure Program Value MLModelStructureProgramValue
- A class representing a constant value in the Program.
- MLModel
Structure Program Value Type MLModelStructureProgramValueType
- A class representing the type of a value or a variable in the Program.
- MLMulti
Array MLMultiArray
- Use
MLMultiArray
to store a multi-dimensional value. - MLMulti
Array Constraint MLMultiArrayConstraint
- Constraint describing expected MLMultiArray properties
- MLMulti
Array Data Type MLMultiArray
- The data type of scalars in the multi-array.
- MLMulti
Array Shape Constraint MLMultiArrayShapeConstraint
- Apple’s documentation
- MLMulti
Array Shape Constraint Type MLMultiArrayShapeConstraintType
- Apple’s documentation
- MLNeural
Engine Compute Device MLNeuralEngineComputeDevice
- Represents a NeuralEngine compute device for inference of machine learning models.
- MLNumeric
Constraint MLNumericConstraint
- Allows enforcement of constraints on the values of update parameters.
- MLOptimization
Hints MLOptimizationHints
- MLOptimizationHints
- MLParameter
Description MLParameterDescription
- Describes a model parameter along with a default value and any applicable constaint on the values.
- MLParameter
Key MLKey
andMLParameterKey
- A class to specify list of supported model update parameters.
- MLPrediction
Options MLPredictionOptions
- MLPredictionOptions
- MLReshape
Frequency Hint MLReshapeFrequencyHint
- The anticipated frequency of changing input shapes
- MLSequence
MLSequence
- An immutable container holding an ordered collection of feature values of the same type.
- MLSequence
Constraint MLSequenceConstraint
- Constraint describing expected MLSequence properties
- MLSpecialization
Strategy MLSpecializationStrategy
- The optimization strategy for the model specialization.
- MLState
MLState
- Handle to the state buffers.
- MLState
Constraint MLStateConstraint
- Constraint of a state feature value.
- MLTask
MLTask
- Class that abstracts state transitions and basic task controls.
- MLTask
State MLTask
- All possible states an MLTask can be in.
- MLUpdate
Context MLUpdateContext
- Provides context for the update process when the progress or completion handlers are invoked.
- MLUpdate
Progress Event MLUpdateProgressEvent
- Events on which update task is capable of invoking progress handler.
- MLUpdate
Progress Handlers MLUpdateProgressHandlers
- Allows applications to register for progress and completion handlers.
- MLUpdate
Task MLTask
andMLUpdateTask
- Main class for setting up and controlling a model update. It provides some utility class methods for performing an update synchronously as well as class constructors for configuring an update and give developers control for the execution of that update.
Statics§
- MLFeature
Value ⚠Image Option Crop AndScale MLFeatureValue_MLImageConversion
- Key for VNImageCropAndScaleOption describing how to crop and scale the image (or region of interest) to the desired size
- MLFeature
Value ⚠Image Option Crop Rect MLFeatureValue_MLImageConversion
- Key for CGRect describing a crop region of interest of image source in normalized coordinates
- MLModel
Author ⚠Key MLModelMetadataKeys
- The author of this model
- MLModel
Collection ⚠DidChange Notification MLModelCollection
- Notification posted when the model collection has changed.
- MLModel
Creator ⚠Defined Key MLModelMetadataKeys
- Any additional pertinent information specified by the model creator
- MLModel
Description ⚠Key MLModelMetadataKeys
- A short description of what the model does and/or its purpose
- MLModel
Error ⚠Domain MLModelError
- Apple’s documentation
- MLModel
License ⚠Key MLModelMetadataKeys
- License information for the model
- MLModel
Version ⚠String Key MLModelMetadataKeys
- A version number encoded as a string
Traits§
- MLBatch
Provider MLBatchProvider
- Protocol for accessing a collection of feature providers
- MLCompute
Device Protocol MLComputeDeviceProtocol
- Protocol for representing a compute device. The represented device is capable of running machine learning computations and other tasks like analysis and processing of images, sound, etc.
- MLCustom
Layer MLCustomLayer
- Apple’s documentation
- MLCustom
Model MLCustomModel
- Apple’s documentation
- MLFeature
Provider MLFeatureProvider
- Apple’s documentation
- MLWritable
MLWritable
- Apple’s documentation
Functions§
- MLAll
Compute ⚠Devices MLAllComputeDevices
andMLComputeDeviceProtocol
- Returns an array containing all compute devices.
Type Aliases§
- MLFeature
Value Image Option MLFeatureValue_MLImageConversion
- Options keys passed into the MLFeatureValue construction for image types
- MLModel
Metadata Key MLModelMetadataKeys
- Keys to a dictionary that holds useful information about a model. All are optional with the aim of being helpful to a developer or user for descriptive purposes.