IRuntime Class Reference

#include <IRuntime.hpp>

Classes
struct	CreationOptions

Public Member Functions
Status	LoadNetwork (NetworkId &networkIdOut, IOptimizedNetworkPtr network)
	Loads a complete network into the IRuntime. More...
Status	LoadNetwork (NetworkId &networkIdOut, IOptimizedNetworkPtr network, std::string &errorMessage)
	Load a complete network into the IRuntime. More...
Status	LoadNetwork (NetworkId &networkIdOut, IOptimizedNetworkPtr network, std::string &errorMessage, const INetworkProperties &networkProperties)
TensorInfo	GetInputTensorInfo (NetworkId networkId, LayerBindingId layerId) const
TensorInfo	GetOutputTensorInfo (NetworkId networkId, LayerBindingId layerId) const
std::vector< ImportedInputId >	ImportInputs (NetworkId networkId, const InputTensors &inputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
	ImportInputs separates the importing and mapping of InputTensors from network execution. More...
std::vector< ImportedOutputId >	ImportOutputs (NetworkId networkId, const OutputTensors &outputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
	ImportOutputs separates the importing and mapping of OutputTensors from network execution. More...
Status	EnqueueWorkload (NetworkId networkId, const InputTensors &inputTensors, const OutputTensors &outputTensors, std::vector< ImportedInputId > preImportedInputIds={}, std::vector< ImportedOutputId > preImportedOutputIds={})
	Evaluates a network using input in inputTensors and outputs filled into outputTensors. More...
Status	UnloadNetwork (NetworkId networkId)
	Unloads a network from the IRuntime. More...
const IDeviceSpec &	GetDeviceSpec () const
const std::shared_ptr< IProfiler >	GetProfiler (NetworkId networkId) const
	Gets the profiler corresponding to the given network id. More...
void	RegisterDebugCallback (NetworkId networkId, const DebugCallbackFunction &func)
	Registers a callback function to debug layers performing custom computations on intermediate tensors. More...

Static Public Member Functions
static IRuntime *	CreateRaw (const CreationOptions &options)
static IRuntimePtr	Create (const CreationOptions &options)
static void	Destroy (IRuntime *runtime)

Protected Member Functions
	IRuntime ()
	IRuntime (const IRuntime::CreationOptions &options)
	~IRuntime ()

Protected Attributes
std::unique_ptr< RuntimeImpl >	pRuntimeImpl

Detailed Description

Definition at line 67 of file IRuntime.hpp.

Constructor & Destructor Documentation

IRuntime() [1/2]

IRuntime ( )

protected

Definition at line 41 of file Runtime.cpp.

: pRuntimeImpl( new RuntimeImpl(armnn::IRuntime::CreationOptions())) {}

Referenced by IRuntime::CreateRaw().

IRuntime() [2/2]

IRuntime ( const IRuntime::CreationOptions &  options )

protected

Definition at line 43 of file Runtime.cpp.

: pRuntimeImpl(new RuntimeImpl(options)) {}

~IRuntime()

~IRuntime ( )

protecteddefault

Member Function Documentation

Create()

IRuntimePtr Create ( const CreationOptions &  options )

static

Examples

CustomMemoryAllocatorSample.cpp, DynamicSample.cpp, and SimpleSample.cpp.

Definition at line 52 of file Runtime.cpp.

{
    return IRuntimePtr(CreateRaw(options), &IRuntime::Destroy);
}

References IRuntime::CreateRaw(), and IRuntime::Destroy().

CreateRaw()

IRuntime * CreateRaw ( const CreationOptions &  options )

static

Definition at line 47 of file Runtime.cpp.

{
    return new IRuntime(options);
}

References IRuntime::IRuntime().

Referenced by IRuntime::Create().

Destroy()

void Destroy ( IRuntime *  runtime )

static

Definition at line 57 of file Runtime.cpp.

{
    delete runtime;
}

Referenced by IRuntime::Create().

EnqueueWorkload()

Status EnqueueWorkload	(	NetworkId	networkId,
		const InputTensors &	inputTensors,
		const OutputTensors &	outputTensors,
		std::vector< ImportedInputId >	preImportedInputIds = {},
		std::vector< ImportedOutputId >	preImportedOutputIds = {}
	)

Evaluates a network using input in inputTensors and outputs filled into outputTensors.

Definition at line 104 of file Runtime.cpp.

{
    return pRuntimeImpl->EnqueueWorkload(networkId, inputTensors, outputTensors,
                                         preImportedInputIds, preImportedOutputIds);
}

References IRuntime::pRuntimeImpl.

GetDeviceSpec()

const IDeviceSpec & GetDeviceSpec

(

)

const

Definition at line 119 of file Runtime.cpp.

{
    return pRuntimeImpl->GetDeviceSpec();
}

References IRuntime::pRuntimeImpl.

GetInputTensorInfo()

armnn::TensorInfo GetInputTensorInfo	(	NetworkId	networkId,
		LayerBindingId	layerId
	)		const

Definition at line 82 of file Runtime.cpp.

{
    return pRuntimeImpl->GetInputTensorInfo(networkId, layerId);
}

References IRuntime::pRuntimeImpl.

GetOutputTensorInfo()

armnn::TensorInfo GetOutputTensorInfo	(	NetworkId	networkId,
		LayerBindingId	layerId
	)		const

Definition at line 87 of file Runtime.cpp.

{
    return pRuntimeImpl->GetOutputTensorInfo(networkId, layerId);
}

References IRuntime::pRuntimeImpl.

GetProfiler()

const std::shared_ptr< IProfiler > GetProfiler

(

NetworkId

networkId

)

const

Gets the profiler corresponding to the given network id.

Parameters

networkId

The id of the network for which to get the profile.

Returns

A pointer to the requested profiler, or nullptr if not found.

Definition at line 124 of file Runtime.cpp.

{
    return pRuntimeImpl->GetProfiler(networkId);
}

References IRuntime::pRuntimeImpl.

ImportInputs()

std::vector< ImportedInputId > ImportInputs	(	NetworkId	networkId,
		const InputTensors &	inputTensors,
		MemorySource	forceImportMemorySource = MemorySource::Undefined
	)

ImportInputs separates the importing and mapping of InputTensors from network execution.

Allowing for a set of InputTensors to be imported and mapped once, but used in execution many times. This function is not thread safe and must not be used while other threads are calling Execute(). No exceptions are thrown for failed imports. It is the caller's responsibility to check whether tensors have been successfully imported by comparing returned ids with those passed in the InputTensors. Whether a tensor can be imported or not is backend specific.

Definition at line 92 of file Runtime.cpp.

{
    return pRuntimeImpl->ImportInputs(networkId, inputTensors, forceImportMemorySource);
}

References IRuntime::pRuntimeImpl.

ImportOutputs()

std::vector< ImportedOutputId > ImportOutputs	(	NetworkId	networkId,
		const OutputTensors &	outputTensors,
		MemorySource	forceImportMemorySource = MemorySource::Undefined
	)

ImportOutputs separates the importing and mapping of OutputTensors from network execution.

Allowing for a set of OutputTensors to be imported and mapped once, but used in execution many times. This function is not thread safe and must not be used while other threads are calling Execute(). No exceptions are thrown for failed imports. It is the caller's responsibility to check whether tensors have been successfully imported by comparing returned ids with those passed in the OutputTensors. Whether a tensor can be imported or not is backend specific.

Definition at line 98 of file Runtime.cpp.

{
    return pRuntimeImpl->ImportOutputs(networkId, outputTensors, forceImportMemorySource);
}

References IRuntime::pRuntimeImpl.

LoadNetwork() [1/3]

Status LoadNetwork	(	NetworkId &	networkIdOut,
		IOptimizedNetworkPtr	network
	)

Loads a complete network into the IRuntime.

Parameters

[out]	networkIdOut	- Unique identifier for the network is returned in this reference.
[in]	network	- Complete network to load into the IRuntime. The runtime takes ownership of the network once passed in.

Returns

armnn::Status

Definition at line 62 of file Runtime.cpp.

{
    return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network));
}

References IRuntime::pRuntimeImpl.

LoadNetwork() [2/3]

Status LoadNetwork	(	NetworkId &	networkIdOut,
		IOptimizedNetworkPtr	network,
		std::string &	errorMessage
	)

Load a complete network into the IRuntime.

Parameters

[out]	networkIdOut	Unique identifier for the network is returned in this reference.
[in]	network	Complete network to load into the IRuntime.
[out]	errorMessage	Error message if there were any errors. The runtime takes ownership of the network once passed in.

Returns

armnn::Status

Definition at line 67 of file Runtime.cpp.

{
    return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network), errorMessage);
}

References IRuntime::pRuntimeImpl.

LoadNetwork() [3/3]

Status LoadNetwork	(	NetworkId &	networkIdOut,
		IOptimizedNetworkPtr	network,
		std::string &	errorMessage,
		const INetworkProperties &	networkProperties
	)

Definition at line 74 of file Runtime.cpp.

{
    return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network), errorMessage, networkProperties);
}

References IRuntime::pRuntimeImpl.

RegisterDebugCallback()

void RegisterDebugCallback	(	NetworkId	networkId,
		const DebugCallbackFunction &	func
	)

Registers a callback function to debug layers performing custom computations on intermediate tensors.

Parameters

networkId	The id of the network to register the callback.
func	callback function to pass to the debug layer.

Definition at line 129 of file Runtime.cpp.

{
    return pRuntimeImpl->RegisterDebugCallback(networkId, func);
}

References IRuntime::pRuntimeImpl.

UnloadNetwork()

Status UnloadNetwork

(

NetworkId

networkId

)

Unloads a network from the IRuntime.

At the moment this only removes the network from the m_Impl->m_Network. This might need more work in the future to be AndroidNN compliant.

Parameters

[in]

networkId

- Unique identifier for the network to be unloaded. Generated in LoadNetwork().

Returns

armnn::Status

Definition at line 114 of file Runtime.cpp.

{
    return pRuntimeImpl->UnloadNetwork(networkId);
}

References IRuntime::pRuntimeImpl.

Member Data Documentation

pRuntimeImpl

std::unique_ptr<RuntimeImpl> pRuntimeImpl

protected

Definition at line 263 of file IRuntime.hpp.

Referenced by IRuntime::EnqueueWorkload(), IRuntime::GetDeviceSpec(), IRuntime::GetInputTensorInfo(), IRuntime::GetOutputTensorInfo(), IRuntime::GetProfiler(), IRuntime::ImportInputs(), IRuntime::ImportOutputs(), IRuntime::LoadNetwork(), IRuntime::RegisterDebugCallback(), and IRuntime::UnloadNetwork().

---

The documentation for this class was generated from the following files:

• include/armnn/IRuntime.hpp
• src/armnn/Runtime.cpp