ORTCheckpoint

Objective-C

@interface ORTCheckpoint : NSObject

Swift

class ORTCheckpoint : NSObject

Ein ORT-Checkpoint ist ein Schnappschuss des Zustands eines Modells zu einem bestimmten Zeitpunkt.

Diese Klasse speichert den gesamten Trainingszustand, der Modellparameter, deren Gradienten, Optimiererparameter und Benutzereigenschaften enthält. Die ORTTrainingSession nutzt die ORTCheckpoint, indem sie den enthaltenen Trainingszustand abruft und aktualisiert.

Verfügbar seit 1.16.

Hinweis

Diese Klasse ist nur verfügbar, wenn die Trainings-APIs aktiviert sind.

-init
Nicht verfügbar
Deklaration
Objective-C

- (instancetype)init NS_UNAVAILABLE;


                      -initWithPath:error:

Erstellt einen Checkpoint aus einem Verzeichnis auf der Festplatte.

Warnung

Die Konstruktion des Checkpoint-Zustands erfordert die Instanziierung von ORTEnv. Die Initialisierung schlägt fehl, wenn die ORTEnv nicht korrekt initialisiert wurde.

Deklaration

Objective-C

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

Swift

init(path: String) throws

Parameter

`pfad`	Der Pfad zum Checkpoint-Verzeichnis.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Die Instanz oder nil, wenn ein Fehler auftritt.


                      -saveCheckpointToPath:withOptimizerState:error:

Speichert einen Checkpoint in einem Verzeichnis auf der Festplatte.

Deklaration

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

Parameter

`pfad`	Der Pfad zum Checkpoint-Verzeichnis.
`includeOptimizerState`	Flag, das angibt, ob der Optimiererzustand gespeichert werden soll oder nicht.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob der Checkpoint erfolgreich gespeichert wurde.


                      -addIntPropertyWithName:value:error:

Fügt eine Integer-Eigenschaft zu diesem Checkpoint hinzu.

Deklaration

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

Parameter

`name`	Der Name der Eigenschaft.
`value`	Der Wert der Eigenschaft.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Eigenschaft erfolgreich hinzugefügt wurde.


                      -addFloatPropertyWithName:value:error:

Fügt eine Float-Eigenschaft zu diesem Checkpoint hinzu.

Deklaration

Objective-C

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

Swift

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

Parameter

`name`	Der Name der Eigenschaft.
`value`	Der Wert der Eigenschaft.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Eigenschaft erfolgreich hinzugefügt wurde.


                      -addStringPropertyWithName:value:error:

Fügt eine String-Eigenschaft zu diesem Checkpoint hinzu.

Deklaration

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

Parameter

`name`	Der Name der Eigenschaft.
`value`	Der Wert der Eigenschaft.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Eigenschaft erfolgreich hinzugefügt wurde.


                      -getIntPropertyWithName:error:

Ruft eine Integer-Eigenschaft von diesem Checkpoint ab.

Deklaration

Objective-C

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

Swift

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

Parameter

`name`	Der Name der Eigenschaft.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Der Wert der Eigenschaft oder 0, wenn ein Fehler auftritt.


                      -getFloatPropertyWithName:error:

Ruft eine Float-Eigenschaft von diesem Checkpoint ab.

Deklaration

Objective-C

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

Swift

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

Parameter

`name`	Der Name der Eigenschaft.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Der Wert der Eigenschaft oder 0.0f, wenn ein Fehler auftritt.


                      -getStringPropertyWithName:error:

Ruft eine String-Eigenschaft von diesem Checkpoint ab.

Deklaration

Objective-C

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

Swift

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

Parameter

`name`	Der Name der Eigenschaft.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Der Wert der Eigenschaft.