MLKitCommon Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
LocalModel
class
LocalModel
:
NSObject
A model stored locally on the device.
-
An absolute path to a model file stored locally on the device.
Declaration
Swift
var
path
:
String
{
get
}
-
An absolute path to a model manifest file stored locally on the device. nil
if the model does
not have a manifest.
Declaration
Swift
var
manifestPath
:
String
?
{
get
}
-
Creates a new instance with the given model file path.
Declaration
Swift
init
(
path
:
String
)
Parameters
path
Absolute path to a model file stored locally on the device.
Return Value
A new LocalModel
instance.
-
Creates a new instance with the given manifest file path of an AutoML Vision Edge model.
Declaration
Swift
init
?(
manifestPath
:
String
)
Parameters
manifestPath
Absolute path to an AutoML Vision Edge model manifest stored locally on the
device.
Return Value
A new LocalModel
instance. nil
if the model manifest at the given manifestPath
is
either missing or invalid.
-
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003eLocalModel\u003c/code\u003e represents a machine learning model stored locally on the device.\u003c/p\u003e\n"],["\u003cp\u003eIt can be initialized with either a model file path or a manifest file path (for AutoML Vision Edge models).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epath\u003c/code\u003e property provides the absolute path to the model file.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emanifestPath\u003c/code\u003e property provides the absolute path to the model manifest file, if available.\u003c/p\u003e\n"]]],["`LocalModel` represents a model stored on the device. It has two key properties: `path`, which is the absolute path to the model file, and `manifestPath`, the absolute path to the model's manifest file (if it exists). You can create a `LocalModel` instance using either `init(path:)`, specifying the model file path, or `init(manifestPath:)`, for AutoML Vision Edge models, using the manifest path. Initializing with the `manifestPath` will return `nil` if the file is missing or invalid.\n"],null,["# MLKitCommon Framework Reference\n\nLocalModel\n==========\n\n class LocalModel : NSObject\n\nA model stored locally on the device.\n- `\n ``\n ``\n `\n\n ### [path](#/c:objc(cs)MLKLocalModel(py)path)\n\n `\n ` \n An absolute path to a model file stored locally on the device. \n\n #### Declaration\n\n Swift \n\n var path: String { get }\n\n- `\n ``\n ``\n `\n\n ### [manifestPath](#/c:objc(cs)MLKLocalModel(py)manifestPath)\n\n `\n ` \n An absolute path to a model manifest file stored locally on the device. `nil` if the model does\n not have a manifest. \n\n #### Declaration\n\n Swift \n\n var manifestPath: String? { get }\n\n- `\n ``\n ``\n `\n\n ### [init(path:)](#/c:objc(cs)MLKLocalModel(im)initWithPath:)\n\n `\n ` \n Creates a new instance with the given model file path. \n\n #### Declaration\n\n Swift \n\n init(path: String)\n\n #### Parameters\n\n |--------------|-------------------------------------------------------------|\n | ` `*path*` ` | Absolute path to a model file stored locally on the device. |\n\n #### Return Value\n\n A new `LocalModel` instance.\n- `\n ``\n ``\n `\n\n ### [init(manifestPath:)](#/c:objc(cs)MLKLocalModel(im)initWithManifestPath:)\n\n `\n ` \n Creates a new instance with the given manifest file path of an AutoML Vision Edge model. \n\n #### Declaration\n\n Swift \n\n init?(manifestPath: String)\n\n #### Parameters\n\n |----------------------|-------------------------------------------------------------------------------------|\n | ` `*manifestPath*` ` | Absolute path to an AutoML Vision Edge model manifest stored locally on the device. |\n\n #### Return Value\n\n A new `LocalModel` instance. `nil` if the model manifest at the given [manifestPath](../Classes/LocalModel.html#/c:objc(cs)MLKLocalModel(py)manifestPath) is\n either missing or invalid.\n- `\n ``\n ``\n `\n\n ### [-init](#/c:objc(cs)MLKLocalModel(im)init)\n\n `\n ` \n Unavailable."]]
