|
| 1 | +// |
| 2 | +// ETCoreMLCacheProtocol.h |
| 3 | +// |
| 4 | +// Copyright © 2024 Apple Inc. All rights reserved. |
| 5 | +// |
| 6 | +// Please refer to the license found in the LICENSE file in the root directory of the source tree. |
| 7 | + |
| 8 | +#import <Foundation/Foundation.h> |
| 9 | + |
| 10 | +NS_ASSUME_NONNULL_BEGIN |
| 11 | + |
| 12 | +/// Protocol defining the interface for CoreML model caching. |
| 13 | +/// |
| 14 | +/// This protocol abstracts the cache implementation |
| 15 | +@protocol ETCoreMLCache <NSObject> |
| 16 | + |
| 17 | +/// Returns the URL of a cached model if it exists and is valid, otherwise nil. |
| 18 | +/// |
| 19 | +/// @param identifier The unique identifier for the cached model. |
| 20 | +/// @param error On failure, error is filled with the failure information. |
| 21 | +/// @return The URL to the cached model bundle, or nil if not found or invalid. |
| 22 | +/// |
| 23 | +/// @warning The returned URL may become invalid before the caller uses it if another |
| 24 | +/// process deletes or replaces the cached model. Callers MUST handle MLModel load |
| 25 | +/// failures gracefully by treating them as cache misses and recompiling. |
| 26 | +- (nullable NSURL*)cachedModelURLForIdentifier:(NSString*)identifier error:(NSError**)error; |
| 27 | + |
| 28 | +/// Stores a compiled model in the cache. Returns the cached URL on success. |
| 29 | +/// |
| 30 | +/// @param compiledModelURL The URL of the compiled model bundle to cache. Must exist. |
| 31 | +/// @param identifier The unique identifier for this model. |
| 32 | +/// @param error On failure, error is filled with the failure information. |
| 33 | +/// @return The URL of the cached model, or nil on failure. |
| 34 | +- (nullable NSURL*)storeModelAtURL:(NSURL*)compiledModelURL withIdentifier:(NSString*)identifier error:(NSError**)error; |
| 35 | + |
| 36 | +/// Removes a specific cached model. |
| 37 | +/// |
| 38 | +/// @param identifier The unique identifier for the cached model to remove. |
| 39 | +/// @param error On failure, error is filled with the failure information. |
| 40 | +/// @return YES if the model was removed or didn't exist. Returns NO only on I/O errors. |
| 41 | +- (BOOL)removeCachedModelWithIdentifier:(NSString*)identifier error:(NSError**)error; |
| 42 | + |
| 43 | +/// Clears the entire cache, including all cached models. |
| 44 | +/// |
| 45 | +/// @param error On failure, error is filled with the failure information. |
| 46 | +/// @return YES if the cache was purged successfully, otherwise NO. |
| 47 | +- (BOOL)purgeAndReturnError:(NSError**)error; |
| 48 | + |
| 49 | +/// Returns a temp URL where intermediate files can be written during compilation. |
| 50 | +/// This is guaranteed to be on the same filesystem as the cache, ensuring atomic moves. |
| 51 | +/// |
| 52 | +/// @param error On failure, error is filled with the failure information. |
| 53 | +/// @return A temp URL where intermediate files can be written, or nil on failure. |
| 54 | +/// |
| 55 | +/// @note The temp URL is unique (UUID-based) to avoid conflicts. |
| 56 | +/// @note Temp entries are cleaned up automatically after 24 hours. |
| 57 | +- (nullable NSURL*)temporaryDirectoryWithError:(NSError**)error; |
| 58 | + |
| 59 | +@end |
| 60 | + |
| 61 | +NS_ASSUME_NONNULL_END |
0 commit comments