2021-07-21 21:25:04 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > ORTSessionOptions Class Reference< / title >
< link rel = "stylesheet" type = "text/css" href = "../css/jazzy.css" / >
< link rel = "stylesheet" type = "text/css" href = "../css/highlight.css" / >
< meta charset = 'utf-8' >
< script src = "../js/jquery.min.js" defer > < / script >
< script src = "../js/jazzy.js" defer > < / script >
< script src = "../js/lunr.min.js" defer > < / script >
< script src = "../js/typeahead.jquery.js" defer > < / script >
< script src = "../js/jazzy.search.js" defer > < / script >
< / head >
< body >
< a name = "//apple_ref/objc/Class/ORTSessionOptions" class = "dashAnchor" > < / a >
< a title = "ORTSessionOptions Class Reference" > < / a >
< header >
< div class = "content-wrapper" >
2022-07-25 19:22:53 +00:00
< p > < a href = "../index.html" > ONNX Runtime Objective-C API Docs< / a > < / p >
2021-12-11 01:37:56 +00:00
< p class = "header-right" > < a href = "https://github.com/microsoft/onnxruntime" > < img src = "../img/gh.png" alt = "GitHub" / > View on GitHub< / a > < / p >
< div class = "header-right" >
2021-07-21 21:25:04 +00:00
< form role = "search" action = "../search.json" >
< input type = "text" placeholder = "Search documentation" data-typeahead >
< / form >
2021-12-11 01:37:56 +00:00
< / div >
2021-07-21 21:25:04 +00:00
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "../index.html" > ONNX Runtime Objective-C API Reference< / a >
2021-12-11 01:37:56 +00:00
< img id = "carat" src = "../img/carat.png" alt = "" / >
2021-07-21 21:25:04 +00:00
ORTSessionOptions Class Reference
< / p >
< / div >
< div class = "content-wrapper" >
< nav class = "sidebar" >
< ul class = "nav-groups" >
< li class = "nav-group-name" >
< a href = "../Classes.html" > Classes< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../Classes/ORTCoreMLExecutionProviderOptions.html" > ORTCoreMLExecutionProviderOptions< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTEnv.html" > ORTEnv< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTRunOptions.html" > ORTRunOptions< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTSession.html" > ORTSession< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTSessionOptions.html" > ORTSessionOptions< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTTensorTypeAndShapeInfo.html" > ORTTensorTypeAndShapeInfo< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTValue.html" > ORTValue< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Classes/ORTValueTypeInfo.html" > ORTValueTypeInfo< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../Enums.html" > Enumerations< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../Enums/ORTGraphOptimizationLevel.html" > ORTGraphOptimizationLevel< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Enums/ORTLoggingLevel.html" > ORTLoggingLevel< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Enums/ORTTensorElementDataType.html" > ORTTensorElementDataType< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Enums/ORTValueType.html" > ORTValueType< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../Functions.html" > Functions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../Functions.html#/c:@F@ORTIsCoreMLExecutionProviderAvailable" > ORTIsCoreMLExecutionProviderAvailable< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< h1 > ORTSessionOptions< / h1 >
< div class = "declaration" >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > @interface< / span > < span class = "nc" > ORTSessionOptions< / span > < span class = "p" > :< / span > < span class = "nc" > NSObject< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > class< / span > < span class = "kt" > ORTSessionOptions< / span > < span class = "p" > :< / span > < span class = "kt" > NSObject< / span > < / code > < / pre >
< / div >
< / div >
< p > Options for configuring a session.< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)init" > < / a >
< a name = "//apple_ref/objc/Method/-init" class = "dashAnchor" > < / a >
< a class = "token discouraged" href = "#/c:objc(cs)ORTSessionOptions(im)init" > -init< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "aside aside-unavailable" >
< p class = "aside-title" > Unavailable< / p >
< / div >
< div class = "abstract" >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > instancetype< / span > < span class = "p" > )< / span > < span class = "n" > init< / span > < span class = "n" > NS_UNAVAILABLE< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)initWithError:" > < / a >
< a name = "//apple_ref/objc/Method/-initWithError:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)initWithError:" > -initWithError:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Creates session configuration options.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > nullable< / span > < span class = "n" > instancetype< / span > < span class = "p" > )< / span > < span class = "nf" > initWithError< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "nf" > init< / span > < span class = "p" > ()< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > The instance, or nil if an error occurs.< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)setIntraOpNumThreads:error:" > < / a >
< a name = "//apple_ref/objc/Method/-setIntraOpNumThreads:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)setIntraOpNumThreads:error:" > -setIntraOpNumThreads:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets the number of threads used to parallelize the execution within nodes.
A value of 0 means ORT will pick a default value.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > setIntraOpNumThreads< / span > < span class = "p" > :(< / span > < span class = "kt" > int< / span > < span class = "p" > )< / span > < span class = "nv" > intraOpNumThreads< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > setIntraOpNumThreads< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > intraOpNumThreads< / span > < span class = "p" > :< / span > < span class = "kt" > Int32< / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > intraOpNumThreads< / em >
< / code >
< / td >
< td >
< div >
< p > The number of threads.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the option was set successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)setGraphOptimizationLevel:error:" > < / a >
< a name = "//apple_ref/objc/Method/-setGraphOptimizationLevel:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)setGraphOptimizationLevel:error:" > -setGraphOptimizationLevel:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets the graph optimization level.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > setGraphOptimizationLevel< / span > < span class = "p" > :< / span >
< span class = "p" > (< / span > < span class = "n" > < a href = "../Enums/ORTGraphOptimizationLevel.html" > ORTGraphOptimizationLevel< / a > < / span > < span class = "p" > )< / span > < span class = "nv" > graphOptimizationLevel< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > setGraphOptimizationLevel< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > graphOptimizationLevel< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Enums/ORTGraphOptimizationLevel.html" > ORTGraphOptimizationLevel< / a > < / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > graphOptimizationLevel< / em >
< / code >
< / td >
< td >
< div >
< p > The graph optimization level.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the option was set successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)setOptimizedModelFilePath:error:" > < / a >
< a name = "//apple_ref/objc/Method/-setOptimizedModelFilePath:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)setOptimizedModelFilePath:error:" > -setOptimizedModelFilePath:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets the path to which the optimized model file will be saved.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > setOptimizedModelFilePath< / span > < span class = "p" > :(< / span > < span class = "n" > nonnull< / span > < span class = "n" > NSString< / span > < span class = "o" > *< / span > < span class = "p" > )< / span > < span class = "nv" > optimizedModelFilePath< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > setOptimizedModelFilePath< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > optimizedModelFilePath< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > optimizedModelFilePath< / em >
< / code >
< / td >
< td >
< div >
< p > The optimized model file path.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the option was set successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)setLogID:error:" > < / a >
< a name = "//apple_ref/objc/Method/-setLogID:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)setLogID:error:" > -setLogID:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets the session log ID.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > setLogID< / span > < span class = "p" > :(< / span > < span class = "n" > nonnull< / span > < span class = "n" > NSString< / span > < span class = "o" > *< / span > < span class = "p" > )< / span > < span class = "nv" > logID< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > setLogID< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > logID< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > logID< / em >
< / code >
< / td >
< td >
< div >
< p > The log ID.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the option was set successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)setLogSeverityLevel:error:" > < / a >
< a name = "//apple_ref/objc/Method/-setLogSeverityLevel:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)setLogSeverityLevel:error:" > -setLogSeverityLevel:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets the session log severity level.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > setLogSeverityLevel< / span > < span class = "p" > :(< / span > < span class = "n" > < a href = "../Enums/ORTLoggingLevel.html" > ORTLoggingLevel< / a > < / span > < span class = "p" > )< / span > < span class = "nv" > loggingLevel< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > setLogSeverityLevel< / span > < span class = "p" > (< / span > < span class = "n" > _< / span > < span class = "nv" > loggingLevel< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Enums/ORTLoggingLevel.html" > ORTLoggingLevel< / a > < / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > loggingLevel< / em >
< / code >
< / td >
< td >
< div >
< p > The log severity level.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the option was set successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)addConfigEntryWithKey:value:error:" > < / a >
< a name = "//apple_ref/objc/Method/-addConfigEntryWithKey:value:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)addConfigEntryWithKey:value:error:" > -addConfigEntryWithKey:< wbr > value:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets a session configuration key-value pair.
Any value for a previously set key will be overwritten.
The session configuration keys and values are documented here:
< a href = "https://github.com/microsoft/onnxruntime/blob/master/include/onnxruntime/core/session/onnxruntime_session_options_config_keys.h" > https://github.com/microsoft/onnxruntime/blob/master/include/onnxruntime/core/session/onnxruntime_session_options_config_keys.h< / a > < / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > addConfigEntryWithKey< / span > < span class = "p" > :(< / span > < span class = "n" > nonnull< / span > < span class = "n" > NSString< / span > < span class = "o" > *< / span > < span class = "p" > )< / span > < span class = "nv" > key< / span >
< span class = "nf" > value< / span > < span class = "p" > :(< / span > < span class = "n" > nonnull< / span > < span class = "n" > NSString< / span > < span class = "o" > *< / span > < span class = "p" > )< / span > < span class = "nv" > value< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span > < span class = "nv" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > addConfigEntry< / span > < span class = "p" > (< / span > < span class = "n" > withKey< / span > < span class = "nv" > key< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span > < span class = "nv" > value< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > key< / em >
< / code >
< / td >
< td >
< div >
< p > The key.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > value< / em >
< / code >
< / td >
< td >
< div >
< p > The value.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the option was set successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< div class = "task-group" >
< div class = "task-name-container" >
< a name = "/ORTSessionOptionsCoreMLEP" > < / a >
< a name = "//apple_ref/objc/Section/ORTSessionOptionsCoreMLEP" class = "dashAnchor" > < / a >
< div class = "section-name-container" >
< a class = "section-name-link" href = "#/ORTSessionOptionsCoreMLEP" > < / a >
2021-12-11 01:37:56 +00:00
< h3 class = "section-name" > < span > ORTSessionOptionsCoreMLEP< / span >
2021-07-21 21:25:04 +00:00
< / h3 >
< / div >
< / div >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/c:objc(cs)ORTSessionOptions(im)appendCoreMLExecutionProviderWithOptions:error:" > < / a >
< a name = "//apple_ref/objc/Method/-appendCoreMLExecutionProviderWithOptions:error:" class = "dashAnchor" > < / a >
< a class = "token" href = "#/c:objc(cs)ORTSessionOptions(im)appendCoreMLExecutionProviderWithOptions:error:" > -appendCoreMLExecutionProviderWithOptions:< wbr > error:< wbr > < / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Enables the CoreML execution provider in the session configuration options.
It is appended to the execution provider list which is ordered by
decreasing priority.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Objective-C< / p >
< pre class = "highlight objective_c" > < code > < span class = "k" > -< / span > < span class = "p" > (< / span > < span class = "n" > BOOL< / span > < span class = "p" > )< / span > < span class = "nf" > appendCoreMLExecutionProviderWithOptions< / span > < span class = "p" > :< / span >
< span class = "p" > (< / span > < span class = "n" > nonnull< / span > < span class = "n" > < a href = "../Classes/ORTCoreMLExecutionProviderOptions.html" > ORTCoreMLExecutionProviderOptions< / a > < / span > < span class = "o" > *< / span > < span class = "p" > )< / span > < span class = "nv" > options< / span >
< span class = "nf" > error< / span > < span class = "p" > :(< / span > < span class = "n" > NSError< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "o" > *< / span > < span class = "n" > _Nullable< / span > < span class = "p" > )< / span >
< span class = "n" > error< / span > < span class = "p" > ;< / span > < / code > < / pre >
< / div >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > func< / span > < span class = "nf" > appendCoreMLExecutionProvider< / span > < span class = "p" > (< / span > < span class = "n" > with< / span > < span class = "nv" > options< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Classes/ORTCoreMLExecutionProviderOptions.html" > ORTCoreMLExecutionProviderOptions< / a > < / span > < span class = "p" > )< / span > < span class = "k" > throws< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > options< / em >
< / code >
< / td >
< td >
< div >
< p > The CoreML execution provider configuration options.< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > error< / em >
< / code >
< / td >
< td >
< div >
< p > Optional error information set if an error occurs.< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > Whether the provider was enabled successfully.< / p >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< / section >
< / section >
< section id = "footer" >
2022-08-08 22:53:59 +00:00
< p > © 2022 < a class = "link" href = "https://www.onnxruntime.ai" target = "_blank" rel = "external noopener" > ONNX Runtime Authors< / a > . All rights reserved. (Last updated: 2022-08-03)< / p >
2022-07-25 19:22:53 +00:00
< p > Generated by < a class = "link" href = "https://github.com/realm/jazzy" target = "_blank" rel = "external noopener" > jazzy ♪♫ v0.14.2< / a > , a < a class = "link" href = "https://realm.io" target = "_blank" rel = "external noopener" > Realm< / a > project.< / p >
2021-07-21 21:25:04 +00:00
< / section >
< / article >
< / div >
< / body >
< / html >
