ONNX Runtime
Loading...
Searching...
No Matches
Ort::RunOptions Struct Reference

RunOptions. More...

#include <onnxruntime_cxx_api.h>

Inheritance diagram for Ort::RunOptions:
Ort::detail::Base< OrtRunOptions >

Public Member Functions

 RunOptions (std::nullptr_t)
 Create an empty RunOptions object, must be assigned a valid one to be used.
 
 RunOptions ()
 Wraps OrtApi::CreateRunOptions.
 
RunOptionsSetRunLogVerbosityLevel (int)
 Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel.
 
int GetRunLogVerbosityLevel () const
 Wraps OrtApi::RunOptionsGetRunLogVerbosityLevel.
 
RunOptionsSetRunLogSeverityLevel (int)
 Wraps OrtApi::RunOptionsSetRunLogSeverityLevel.
 
int GetRunLogSeverityLevel () const
 Wraps OrtApi::RunOptionsGetRunLogSeverityLevel.
 
RunOptionsSetRunTag (const char *run_tag)
 wraps OrtApi::RunOptionsSetRunTag
 
const char * GetRunTag () const
 Wraps OrtApi::RunOptionsGetRunTag.
 
RunOptionsAddConfigEntry (const char *config_key, const char *config_value)
 Wraps OrtApi::AddRunConfigEntry.
 
RunOptionsSetTerminate ()
 Terminates all currently executing Session::Run calls that were made using this RunOptions instance.
 
RunOptionsUnsetTerminate ()
 Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without it instantly terminating.
 
- Public Member Functions inherited from Ort::detail::Base< OrtRunOptions >
constexpr Base ()=default
 
constexpr Base (contained_type *p) noexcept
 
 Base (const Base &)=delete
 
 Base (Base &&v) noexcept
 
 ~Base ()
 
Baseoperator= (const Base &)=delete
 
Baseoperator= (Base &&v) noexcept
 
constexpr operator contained_type * () const noexcept
 
contained_typerelease ()
 Relinquishes ownership of the contained C object pointer The underlying object is not destroyed.
 

Additional Inherited Members

- Public Types inherited from Ort::detail::Base< OrtRunOptions >
using contained_type = OrtRunOptions
 
- Protected Attributes inherited from Ort::detail::Base< OrtRunOptions >
contained_typep_
 

Detailed Description

Constructor & Destructor Documentation

◆ RunOptions() [1/2]

Ort::RunOptions::RunOptions ( std::nullptr_t  )
inlineexplicit

Create an empty RunOptions object, must be assigned a valid one to be used.

◆ RunOptions() [2/2]

Ort::RunOptions::RunOptions ( )

Member Function Documentation

◆ AddConfigEntry()

RunOptions & Ort::RunOptions::AddConfigEntry ( const char *  config_key,
const char *  config_value 
)

◆ GetRunLogSeverityLevel()

int Ort::RunOptions::GetRunLogSeverityLevel ( ) const

◆ GetRunLogVerbosityLevel()

int Ort::RunOptions::GetRunLogVerbosityLevel ( ) const

◆ GetRunTag()

const char * Ort::RunOptions::GetRunTag ( ) const

◆ SetRunLogSeverityLevel()

RunOptions & Ort::RunOptions::SetRunLogSeverityLevel ( int  )

◆ SetRunLogVerbosityLevel()

RunOptions & Ort::RunOptions::SetRunLogVerbosityLevel ( int  )

◆ SetRunTag()

RunOptions & Ort::RunOptions::SetRunTag ( const char *  run_tag)

◆ SetTerminate()

RunOptions & Ort::RunOptions::SetTerminate ( )

Terminates all currently executing Session::Run calls that were made using this RunOptions instance.

If a currently executing session needs to be force terminated, this can be called from another thread to force it to fail with an error Wraps OrtApi::RunOptionsSetTerminate

◆ UnsetTerminate()

RunOptions & Ort::RunOptions::UnsetTerminate ( )

Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without it instantly terminating.

Wraps OrtApi::RunOptionsUnsetTerminate