跳到主要内容

EdgeModelKit API 参考

EdgeModelKit 包含模型下载、缓存管理和设备层级选择 helper。

HFDownloader

public final class HFDownloader: NSObject

将已注册模型下载到本地模型缓存。

API描述
HFDownloader.shared共享 downloader 实例。
download(config:progress:)下载 ModelConfig 的文件。
cancel(modelID:)取消某个 model ID 的活跃下载。

示例:

try await HFDownloader.shared.download(config: config) { progress in
print(progress)
}

ModelCache

public final class ModelCache

管理本地模型缓存目录。

API描述
ModelCache.shared共享缓存管理器。
cachedURL(for:)返回某个模型配置的本地缓存 URL。
isCached(_:)检查模型目录是否存在。
cacheSize(for:)返回单个模型目录的字节大小。
totalCacheSize()返回总缓存字节大小。
evict(_:)移除一个已缓存模型。
evictAll()移除所有已缓存模型。

ModelTierManager

public final class ModelTierManager: ObservableObject

为当前设备选择模型层级。

属性或方法描述
ModelTierManager.shared共享层级管理器。
currentTier当前推荐或已选择层级。
availableTiers此设备上可用的层级。
refresh()重新计算可用层级。
select(tier:)选择一个可用层级。
currentConfig当前层级对应的 ModelConfig

ModelTier

public enum ModelTier: String, CaseIterable, Sendable
Case预期用途
.standard面向广泛设备支持的较小模型。
.pro中等规模模型。
.max面向较高内存设备的较大模型。
.ultra面向已验证设备的最高本地层级。