mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-06-24 02:47:54 +00:00
fd8ad9b950
### Description Enable support for building iOS packages/CocoaPods with training API - Add `Training` Package variant and config files in current iOS packaging utilities to enable creation of training packages ### Motivation and Context This PR introduces new `Training` variant in `build_and_assemble_ios_pods.py` script which allows creating pods for iOS with training API enabled. The sample script to build training pods: ``` python3 tools/ci_build/github/apple/build_and_assemble_ios_pods.py --variant Training \ --build-settings-file tools/ci_build/github/apple/default_full_ios_training_framework_build_settings.json \ -b=-- path_to_protoc_exe=<path/to/protoc> ``` Note: build settings file should have `--enable_training` as a build parameter. Simply adding training packaging increases the duration of the Azure pipeline for packaging by 70 minutes. To address this issue, we need to parallelize pod creation. In order not to further strain the pipeline, the changes for training packaging will be added in another PR, which optimizes the packaging pipeline. --------- Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
122 lines
4.3 KiB
Objective-C
122 lines
4.3 KiB
Objective-C
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// Licensed under the MIT License.
|
|
|
|
#import <Foundation/Foundation.h>
|
|
#include <stdint.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* An ORT checkpoint is a snapshot of the state of a model at a given point in time.
|
|
*
|
|
* This class holds the entire training session state that includes model parameters,
|
|
* their gradients, optimizer parameters, and user properties. The `ORTTrainingSession` leverages the
|
|
* `ORTCheckpoint` by accessing and updating the contained training state.
|
|
*
|
|
* Available since v1.16.0.
|
|
*
|
|
* @note Note that the training session created with a checkpoint state uses this state to store the entire training
|
|
* state (including model parameters, its gradients, the optimizer states and the properties). The ORTTraingSession
|
|
* does not hold a copy of the checkpoint state. Therefore, it is required that the checkpoint state outlive the
|
|
* lifetime of the training session.
|
|
*/
|
|
@interface ORTCheckpoint : NSObject
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
* Creates a checkpoint from directory on disk.
|
|
*
|
|
* @param path The path to the checkpoint directory.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return The instance, or nil if an error occurs.
|
|
*
|
|
* @warning The construction of the checkpoint state requires instantiation of `ORTEnv`.
|
|
* The intialization will fail if the `ORTEnv` is not properly initialized.
|
|
*/
|
|
- (nullable instancetype)initWithPath:(NSString*)path
|
|
error:(NSError**)error NS_DESIGNATED_INITIALIZER;
|
|
|
|
/**
|
|
* Saves a checkpoint to directory on disk.
|
|
*
|
|
* @param path The path to the checkpoint directory.
|
|
* @param includeOptimizerState Flag to indicate whether to save the optimizer state or not.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return Whether the checkpoint was saved successfully.
|
|
*/
|
|
- (BOOL)saveCheckpointToPath:(NSString*)path
|
|
withOptimizerState:(BOOL)includeOptimizerState
|
|
error:(NSError**)error;
|
|
|
|
/**
|
|
* Adds an int property to this checkpoint.
|
|
*
|
|
* @param name The name of the property.
|
|
* @param value The value of the property.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return Whether the property was added successfully.
|
|
*/
|
|
- (BOOL)addIntPropertyWithName:(NSString*)name
|
|
value:(int64_t)value
|
|
error:(NSError**)error;
|
|
|
|
/**
|
|
* Adds a float property to this checkpoint.
|
|
*
|
|
* @param name The name of the property.
|
|
* @param value The value of the property.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return Whether the property was added successfully.
|
|
*/
|
|
- (BOOL)addFloatPropertyWithName:(NSString*)name
|
|
value:(float)value
|
|
error:(NSError**)error;
|
|
|
|
/**
|
|
* Adds a string property to this checkpoint.
|
|
*
|
|
* @param name The name of the property.
|
|
* @param value The value of the property.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return Whether the property was added successfully.
|
|
*/
|
|
|
|
- (BOOL)addStringPropertyWithName:(NSString*)name
|
|
value:(NSString*)value
|
|
error:(NSError**)error;
|
|
|
|
/**
|
|
* Gets an int property from this checkpoint.
|
|
*
|
|
* @param name The name of the property.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return The value of the property or 0 if an error occurs.
|
|
*/
|
|
- (int64_t)getIntPropertyWithName:(NSString*)name
|
|
error:(NSError**)error __attribute__((swift_error(nonnull_error)));
|
|
|
|
/**
|
|
* Gets a float property from this checkpoint.
|
|
*
|
|
* @param name The name of the property.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return The value of the property or 0.0f if an error occurs.
|
|
*/
|
|
- (float)getFloatPropertyWithName:(NSString*)name
|
|
error:(NSError**)error __attribute__((swift_error(nonnull_error)));
|
|
|
|
/**
|
|
*
|
|
* Gets a string property from this checkpoint.
|
|
*
|
|
* @param name The name of the property.
|
|
* @param error Optional error information set if an error occurs.
|
|
* @return The value of the property.
|
|
*/
|
|
- (nullable NSString*)getStringPropertyWithName:(NSString*)name
|
|
error:(NSError**)error __attribute__((swift_error(nonnull_error)));
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|