Classes
The following classes are available globally.
-
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 theORTCheckpoint
by accessing and updating the contained training state.Available since 1.16.
Note
This class is only available when the training APIs are enabled.Declaration
Objective-C
@interface ORTCheckpoint : NSObject
Swift
class ORTCheckpoint : NSObject
-
Options for configuring the CoreML execution provider.
See moreDeclaration
Objective-C
@interface ORTCoreMLExecutionProviderOptions : NSObject
Swift
class ORTCoreMLExecutionProviderOptions : NSObject
-
Options for configuring a session.
See moreDeclaration
Objective-C
@interface ORTSessionOptions : NSObject
Swift
class ORTSessionOptions : NSObject
-
The ORT environment. It maintains shared state including the default logger.
Note
One ORTEnv should be created before and destroyed after other ORT API usage.Declaration
Objective-C
@interface ORTEnv : NSObject
Swift
class ORTEnv : NSObject
-
An ORT session loads and runs a model.
See moreDeclaration
Objective-C
@interface ORTSession : NSObject
Swift
class ORTSession : NSObject
-
Options for configuring a run.
See moreDeclaration
Objective-C
@interface ORTRunOptions : NSObject
Swift
class ORTRunOptions : NSObject
-
Trainer class that provides methods to train, evaluate and optimize ONNX models.
The training session requires four training artifacts:
- Training onnx model
- Evaluation onnx model (optional)
- Optimizer onnx model
- Checkpoint directory
onnxruntime-training python utility can be used to generate above training artifacts.
Available since 1.16.
Note
This class is only available when the training APIs are enabled.Declaration
Objective-C
@interface ORTTrainingSession : NSObject
Swift
class ORTTrainingSession : NSObject
-
An ORT value encapsulates data used as an input or output to a model at runtime.
See moreDeclaration
Objective-C
@interface ORTValue : NSObject
Swift
class ORTValue : NSObject
-
A value’s type information.
See moreDeclaration
Objective-C
@interface ORTValueTypeInfo : NSObject
Swift
class ORTValueTypeInfo : NSObject
-
A tensor’s type and shape information.
See moreDeclaration
Objective-C
@interface ORTTensorTypeAndShapeInfo : NSObject
Swift
class ORTTensorTypeAndShapeInfo : NSObject
-
Options for configuring the Xnnpack execution provider.
See moreDeclaration
Objective-C
@interface ORTXnnpackExecutionProviderOptions : NSObject
Swift
class ORTXnnpackExecutionProviderOptions : NSObject