ORTSessionOptions

Objective-C

@interface ORTSessionOptions : NSObject

Swift

class ORTSessionOptions : NSObject

Optionen zur Konfiguration einer Sitzung.

-init
Nicht verfügbar
Deklaration
Objective-C

- (instancetype)init NS_UNAVAILABLE;


                      -initWithError:

Erstellt Sitzungskonfigurationsoptionen.

Deklaration

Objective-C

- (nullable instancetype)initWithError:(NSError *_Nullable *_Nullable)error;

Swift

init() throws

Parameter


                                fehler

Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Die Instanz oder nil, wenn ein Fehler auftritt.


                      -appendExecutionProvider:providerOptions:error:

Fügt einen Ausführungsanbieter zu den Sitzungsoptionen hinzu, um den Ausführungsanbieter für die Ausführung des Modells zu aktivieren.

Verfügbar seit 1.14.

Die Liste der Ausführungsanbieter ist nach absteigender Priorität geordnet. D.h. der zuerst registrierte Anbieter hat die höchste Priorität.

Deklaration

Objective-C

- (BOOL)appendExecutionProvider:(nonnull NSString *)providerName
                providerOptions:(nonnull NSDictionary<NSString *, NSString *> *)
                                    providerOptions
                          error:(NSError *_Nullable *_Nullable)error;

Swift

func appendExecutionProvider(_ providerName: String, providerOptions: [String : String] = [:]) throws

Parameter

`providerName`	Name des Anbieters. Zum Beispiel "xnnpack".
`providerOptions`	Anbieterspezifische Optionen. Zum Beispiel für den Anbieter "xnnpack": {"intra_op_num_threads": "2"}.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob der Ausführungsanbieter erfolgreich hinzugefügt wurde.


                      -setIntraOpNumThreads:error:

Legt die Anzahl der Threads fest, die zur Parallelisierung der Ausführung innerhalb von Knoten verwendet werden. Ein Wert von 0 bedeutet, dass ORT einen Standardwert wählt.

Deklaration

Objective-C

- (BOOL)setIntraOpNumThreads:(int)intraOpNumThreads
                       error:(NSError *_Nullable *_Nullable)error;

Swift

func setIntraOpNumThreads(_ intraOpNumThreads: Int32) throws

Parameter

`intraOpNumThreads`	Die Anzahl der Threads.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Option erfolgreich gesetzt wurde.


                      -setGraphOptimizationLevel:error:

Legt die Optimierungsstufe des Graphen fest.

Deklaration

Objective-C

- (BOOL)setGraphOptimizationLevel:
            (ORTGraphOptimizationLevel)graphOptimizationLevel
                            error:(NSError *_Nullable *_Nullable)error;

Swift

func setGraphOptimizationLevel(_ graphOptimizationLevel: ORTGraphOptimizationLevel) throws

Parameter

`graphOptimizationLevel`	Die Optimierungsstufe des Graphen.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Option erfolgreich gesetzt wurde.


                      -setOptimizedModelFilePath:error:

Legt den Pfad fest, unter dem die optimierte Modelldatei gespeichert werden soll.

Deklaration

Objective-C

- (BOOL)setOptimizedModelFilePath:(nonnull NSString *)optimizedModelFilePath
                            error:(NSError *_Nullable *_Nullable)error;

Swift

func setOptimizedModelFilePath(_ optimizedModelFilePath: String) throws

Parameter

`optimizedModelFilePath`	Der Pfad zur optimierten Modelldatei.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Option erfolgreich gesetzt wurde.


                      -setLogID:error:

Legt die Sitzungsprotokoll-ID fest.

Deklaration

Objective-C

- (BOOL)setLogID:(nonnull NSString *)logID
           error:(NSError *_Nullable *_Nullable)error;

Swift

func setLogID(_ logID: String) throws

Parameter

`logID`	Die Protokoll-ID.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Option erfolgreich gesetzt wurde.


                      -setLogSeverityLevel:error:

Legt die Schweregradstufe der Sitzungsprotokollierung fest.

Deklaration

Objective-C

- (BOOL)setLogSeverityLevel:(ORTLoggingLevel)loggingLevel
                      error:(NSError *_Nullable *_Nullable)error;

Swift

func setLogSeverityLevel(_ loggingLevel: ORTLoggingLevel) throws

Parameter

`loggingLevel`	Die Schweregradstufe der Protokollierung.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Option erfolgreich gesetzt wurde.


                      -addConfigEntryWithKey:value:error:

Legt ein Sitzungskonfigurations-Schlüssel-Wert-Paar fest. Jeder Wert für einen zuvor gesetzten Schlüssel wird überschrieben. Die Schlüssel und Werte der Sitzungskonfiguration sind hier dokumentiert: https://github.com/microsoft/onnxruntime/blob/main/include/onnxruntime/core/session/onnxruntime_session_options_config_keys.h

Deklaration

Objective-C

- (BOOL)addConfigEntryWithKey:(nonnull NSString *)key
                        value:(nonnull NSString *)value
                        error:(NSError *_Nullable *_Nullable)error;

Swift

func addConfigEntry(withKey key: String, value: String) throws

Parameter

`key`	Der Schlüssel.
`value`	Der Wert.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Option erfolgreich gesetzt wurde.


                      -registerCustomOpsUsingFunction:error:

Registriert benutzerdefinierte Operatoren zur Verwendung mit ORTSessions unter Verwendung dieser SessionOptions, indem die angegebene native Funktionsbezeichnung aufgerufen wird. Die benutzerdefinierte Operatorbibliothek muss entweder mitverknüpft sein oder zuvor vom Benutzer geladen worden sein.

Verfügbar seit 1.14.

Die Registrierungsfunktion muss die Signatur haben: OrtStatus* (*fn)(OrtSessionOptions* options, const OrtApiBase* api);

Die Signatur ist in der ONNX Runtime C-API definiert: https://github.com/microsoft/onnxruntime/blob/67f4cd54fab321d83e4a75a40efeee95a6a17079/include/onnxruntime/core/session/onnxruntime_c_api.h#L697

Weitere Informationen zu benutzerdefinierten Operatoren finden Sie unter https://onnxruntime.de/docs/reference/operators/add-custom-op.html. Ein Beispiel für eine benutzerdefinierte Operatorbibliotheksregistrierungsfunktion finden Sie unter https://github.com/microsoft/onnxruntime/blob/342a5bf2b756d1a1fc6fdc582cfeac15182632fe/onnxruntime/test/testdata/custom_op_library/custom_op_library.cc#L115.

Hinweis

Der Aufrufer muss sicherstellen, dass registrationFuncName eine gültige Funktion bezeichnet, die für den nativen ONNX Runtime-Code sichtbar ist und die richtige Signatur hat. Sie müssen sicherstellen, dass die Funktion das tut, was sie erwartet, da diese Methode sie nur aufruft.

Deklaration

Objective-C

- (BOOL)registerCustomOpsUsingFunction:(nonnull NSString *)registrationFuncName
                                 error:(NSError *_Nullable *_Nullable)error;

Swift

func registerCustomOps(usingFunction registrationFuncName: String) throws

Parameter

`registrationFuncName`	Der Name der aufzurufenden Registrierungsfunktion.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Registrierungsfunktion erfolgreich aufgerufen wurde.


                      -registerCustomOpsUsingFunctionPointer:error:

Registriert benutzerdefinierte Operatoren zur Verwendung mit ORTSessions unter Verwendung dieser SessionOptions, indem die angegebene Funktion, auf die von registerCustomOpsFn verwiesen wird, aufgerufen wird.

Verfügbar seit 1.16.

Die Registrierungsfunktion muss die Signatur haben: OrtStatus* (*fn)(OrtSessionOptions* options, const OrtApiBase* api);

Die Signatur ist in der ONNX Runtime C-API definiert: https://github.com/microsoft/onnxruntime/blob/67f4cd54fab321d83e4a75a40efeee95a6a17079/include/onnxruntime/core/session/onnxruntime_c_api.h#L697

Hinweis

Der Aufrufer muss sicherstellen, dass registerCustomOpsFn ein gültiger Funktionszeiger ist und die richtige Signatur hat. Sie müssen sicherstellen, dass die Funktion das tut, was sie erwartet, da diese Methode sie nur aufruft.

Deklaration

Objective-C

- (BOOL)registerCustomOpsUsingFunctionPointer:
            (nonnull ORTCAPIRegisterCustomOpsFnPtr)registerCustomOpsFn
                                        error:(NSError *_Nullable *_Nullable)
                                                  error;

Swift

func registerCustomOps(functionPointer registerCustomOpsFn: ORTCAPIRegisterCustomOpsFnPtr) throws

Parameter

`registerCustomOpsFn`	Ein Zeiger auf die aufzurufende Registrierungsfunktion.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die Registrierungsfunktion erfolgreich aufgerufen wurde.


                      -enableOrtExtensionsCustomOpsWithError:

Registriert ONNX Runtime Extensions benutzerdefinierte Operatoren, die in ONNX Runtime integriert sind.

Verfügbar seit 1.16.

Hinweis

ONNX Runtime muss mit dem Flag --use_extensions kompiliert worden sein, damit die ONNX Runtime Extensions benutzerdefinierten Operatoren mit dieser Methode registriert werden können. Bei Verwendung einer separaten ONNX Runtime Extensions-Bibliothek verwenden Sie stattdessen registerCustomOpsUsingFunctionPointer:error:.

Deklaration

Objective-C

- (BOOL)enableOrtExtensionsCustomOpsWithError:
    (NSError *_Nullable *_Nullable)error;

Swift

func enableOrtExtensionsCustomOps() throws

Parameter


                                fehler

Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob die ONNX Runtime Extensions benutzerdefinierten Operatoren erfolgreich registriert wurden.

ORTSessionOptionsCoreMLEP


                      -appendCoreMLExecutionProviderWithOptions:error:

Aktiviert den CoreML-Ausführungsanbieter in den Sitzungskonfigurationsoptionen. Er wird zur Liste der Ausführungsanbieter hinzugefügt, die nach absteigender Priorität geordnet ist.

Deklaration

Objective-C

- (BOOL)appendCoreMLExecutionProviderWithOptions:
            (nonnull ORTCoreMLExecutionProviderOptions *)options
                                           error:(NSError *_Nullable *_Nullable)
                                                     error;

Swift

func appendCoreMLExecutionProvider(with options: ORTCoreMLExecutionProviderOptions) throws

Parameter

`Optionen`	Die Konfigurationsoptionen für den CoreML-Ausführungsanbieter.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob der Anbieter erfolgreich aktiviert wurde.


                      -appendCoreMLExecutionProviderWithOptionsV2:error:

Aktiviert den CoreML-Ausführungsanbieter in den Sitzungskonfigurationsoptionen. Er wird zur Liste der Ausführungsanbieter hinzugefügt, die nach absteigender Priorität geordnet ist.

Deklaration

Objective-C

- (BOOL)appendCoreMLExecutionProviderWithOptionsV2:
            (nonnull NSDictionary *)provider_options
                                             error:
                                                 (NSError *_Nullable *_Nullable)
                                                     error;

Swift

func appendCoreMLExecutionProvider(withOptionsV2 provider_options: [AnyHashable : Any] = [:]) throws

Parameter


                                provider_options

Die CoreML-Ausführungsanbieter-Optionen im Wörterbuch. Verfügbare Schlüssel-Werte: weitere Details in core/providers/coreml/coreml_execution_provider.h kCoremlProviderOption_MLComputeUnits: eines von "CPUAndNeuralEngine", "CPUAndGPU", "CPUOnly", "All" kCoremlProviderOption_ModelFormat: eines von "MLProgram", "NeuralNetwork" kCoremlProviderOption_RequireStaticInputShapes: "1" oder "0" kCoremlProviderOption_EnableOnSubgraphs: "1" oder "0"


                                fehler

Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob der Anbieter erfolgreich aktiviert wurde.

ORTSessionOptionsXnnpackEP


                      -appendXnnpackExecutionProviderWithOptions:error:

Verfügbar seit 1.14. Aktiviert den Xnnpack-Ausführungsanbieter in den Sitzungskonfigurationsoptionen. Er wird zur Liste der Ausführungsanbieter hinzugefügt, die nach absteigender Priorität geordnet ist.

Deklaration

Objective-C

- (BOOL)appendXnnpackExecutionProviderWithOptions:
            (nonnull ORTXnnpackExecutionProviderOptions *)options
                                            error:
                                                (NSError *_Nullable *_Nullable)
                                                    error;

Swift

func appendXnnpackExecutionProvider(with options: ORTXnnpackExecutionProviderOptions) throws

Parameter

`Optionen`	Die Konfigurationsoptionen für den Xnnpack-Ausführungsanbieter.
`fehler`	Optionale Fehlerinformationen, die gesetzt werden, wenn ein Fehler auftritt.

Rückgabewert

Ob der Anbieter erfolgreich aktiviert wurde.