ORTCheckpoint

Objective-C

@interface ORTCheckpoint : NSObject

Swift

class ORTCheckpoint : NSObject

ORT 檢查點是模型在給定時間點的狀態快照。

此類包含完整的訓練會話狀態，其中包括模型引數、其梯度、最佳化器引數和使用者屬性。ORTTrainingSession 透過訪問和更新所包含的訓練狀態來利用 ORTCheckpoint。

自 1.16 版起可用。

注意

此類別僅在啟用訓練 API 時可用。

  • 不可用

    宣告

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • 從磁碟上的目錄建立檢查點。

    警告

    檢查點狀態的構建需要例項化 ORTEnv。如果 ORTEnv 未正確初始化，則初始化將失敗。

    宣告

    Objective-C

    - (nullable instancetype)initWithPath:(nonnull NSString *)path
                                error:(NSError *_Nullable *_Nullable)error;

    Swift

    init(path: String) throws

    引數

    path

    檢查點目錄的路徑。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    例項，如果發生錯誤則為 nil。

  • 將檢查點儲存到磁碟上的目錄。

    宣告

    Objective-C

    - (BOOL)saveCheckpointToPath:(nonnull NSString *)path
          withOptimizerState:(BOOL)includeOptimizerState
                       error:(NSError *_Nullable *_Nullable)error;

    Swift

    func save(toPath path: String, withOptimizerState includeOptimizerState: Bool) throws

    引數

    path

    檢查點目錄的路徑。
    includeOptimizerState

    指示是否儲存最佳化器狀態的標誌。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    檢查點是否儲存成功。

  • 向此檢查點新增一個整型屬性。

    宣告

    Objective-C

    - (BOOL)addIntPropertyWithName:(nonnull NSString *)name
                         value:(int64_t)value
                         error:(NSError *_Nullable *_Nullable)error;

    Swift

    func addIntProperty(withName name: String, value: Int64) throws

    引數

    name

    屬性的名稱。
    value

    屬性的值。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    屬性是否新增成功。

  • 向此檢查點新增一個浮點型屬性。

    宣告

    Objective-C

    - (BOOL)addFloatPropertyWithName:(nonnull NSString *)name
                           value:(float)value
                           error:(NSError *_Nullable *_Nullable)error;

    Swift

    func addFloatProperty(withName name: String, value: Float) throws

    引數

    name

    屬性的名稱。
    value

    屬性的值。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    屬性是否新增成功。

  • 向此檢查點新增一個字串屬性。

    宣告

    Objective-C

    - (BOOL)addStringPropertyWithName:(nonnull NSString *)name
                            value:(nonnull NSString *)value
                            error:(NSError *_Nullable *_Nullable)error;

    Swift

    func addStringProperty(withName name: String, value: String) throws

    引數

    name

    屬性的名稱。
    value

    屬性的值。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    屬性是否新增成功。

  • 從此檢查點獲取一個整型屬性。

    宣告

    Objective-C

    - (int64_t)getIntPropertyWithName:(nonnull NSString *)name
                            error:(NSError *_Nullable *_Nullable)error;

    Swift

    func getIntProperty(withName name: String) throws -> Int64

    引數

    name

    屬性的名稱。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    屬性的值，如果發生錯誤則為 0。

  • 從此檢查點獲取一個浮點型屬性。

    宣告

    Objective-C

    - (float)getFloatPropertyWithName:(nonnull NSString *)name
                            error:(NSError *_Nullable *_Nullable)error;

    Swift

    func getFloatProperty(withName name: String) throws -> Float

    引數

    name

    屬性的名稱。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    屬性的值，如果發生錯誤則為 0.0f。

  • 從此檢查點獲取一個字串屬性。

    宣告

    Objective-C

    - (nullable NSString *)getStringPropertyWithName:(nonnull NSString *)name
                                           error:(NSError *_Nullable *_Nullable)
                                                     error;

    Swift

    func getStringProperty(withName name: String) throws -> String?

    引數

    name

    屬性的名稱。
    error

    如果發生錯誤，則設定可選的錯誤資訊。

    返回值

    屬性的值。