UE::NNE Namespace Reference

Namespaces
namespace	ModelData
namespace	TypesUtils

Classes
class	FRegistry
class	FSharedModelData
class	FSymbolicTensorShape
struct	FTensorBindingCPU
struct	FTensorBindingRDG
class	FTensorDesc
class	FTensorShape
class	IModelCPU
class	IModelGPU
class	IModelInstanceCPU
class	IModelInstanceGPU
class	IModelInstanceNPU
class	IModelInstanceRDG
class	IModelInstanceRunSync
class	IModelNPU
class	IModelRDG

Typedefs
using	ERegisterRuntimeStatus = EResultStatus
using	EUnregisterRuntimeStatus = EResultStatus
typedef FTensorBindingCPU	FTensorBindingGPU

Enumerations
enum class	EResultStatus : uint8 { Ok = 0 , Fail = 1 }

Functions
ERegisterRuntimeStatus	RegisterRuntime (TWeakInterfacePtr< INNERuntime > Runtime)
EUnregisterRuntimeStatus	UnregisterRuntime (TWeakInterfacePtr< INNERuntime > Runtime)
TArray< FString >	GetAllRuntimeNames ()
TWeakInterfacePtr< INNERuntime >	GetRuntime (const FString &Name)
int32	GetTensorDataTypeSizeInBytes (ENNETensorDataType InType)
template<class T >
TWeakInterfacePtr< T >	GetRuntime (const FString &Name)
template<class T >
TArray< FString >	GetAllRuntimeNames ()

Typedef Documentation

ERegisterRuntimeStatus

using UE::NNE::ERegisterRuntimeStatus = typedef EResultStatus

EUnregisterRuntimeStatus

using UE::NNE::EUnregisterRuntimeStatus = typedef EResultStatus

FTensorBindingGPU

typedef FTensorBindingCPU UE::NNE::FTensorBindingGPU

Enumeration Type Documentation

EResultStatus

enum class UE::NNE::EResultStatus : uint8

strong

Enumerator
Ok
Fail

Function Documentation

GetAllRuntimeNames() [1/2]

NNE_API TArray< FString > UE::NNE::GetAllRuntimeNames

(

)

List and return all registered runtime names.

Returns

An array containing runtime names of all registered runtimes.

GetAllRuntimeNames() [2/2]

template<class T >

TArray< FString > UE::NNE::GetAllRuntimeNames

(

)

List and return all registered runtime names that implement the provided interface.

Returns

An array containing runtime names of all registered runtimes that implement the interface in the template argument.

GetRuntime() [1/2]

NNE_API TWeakInterfacePtr< INNERuntime > UE::NNE::GetRuntime

(

const FString &

Name

)

Find and return a runtime by name.

This function tries to find a runtime by name.

Parameters

Name	The name of the runtime.

Returns

A weak pointer to the runtime if it has been found or an invalid pointer otherwise.

GetRuntime() [2/2]

template<class T >

TWeakInterfacePtr< T > UE::NNE::GetRuntime

(

const FString &

Name

)

Find and return a runtime by name and interface.

This function tries to find a runtime by name and casts it to the interface passed as template argument (e.g. INNERuntime, INNERuntimeCPU or INNERuntimeRDG).

Parameters

Name	The name of the runtime.

Returns

A weak pointer to the runtime if it has been found and implements the interface in the template argument or an invalid pointer otherwise.

GetTensorDataTypeSizeInBytes()

int32 NNE_API UE::NNE::GetTensorDataTypeSizeInBytes

(

ENNETensorDataType

InType

)

Return the data size in bytes for a tensor data type.

Parameters

InType

the type of the element to consider.

Returns

the data size in bytes of an element.

RegisterRuntime()

NNE_API ERegisterRuntimeStatus UE::NNE::RegisterRuntime

(

TWeakInterfacePtr< INNERuntime >

Runtime

)

Register a runtime to make it accessible to NNE clients.

The caller needs to keep a strong pointer to the runtime object to prevent it from being garbage collected.

Parameters

Runtime

A weak interface pointer to the runtime to be registered.

Returns

Status indicating success or failure (e.g. if the runtime already has been registered).

UnregisterRuntime()

NNE_API EUnregisterRuntimeStatus UE::NNE::UnregisterRuntime

(

TWeakInterfacePtr< INNERuntime >

Runtime

)

Unregister a registered runtime.

Parameters

Runtime

A weak interface pointer to the runtime to be unregistered.

Returns

Status indicating success or failure (e.g. if the runtime has not been registered).