xref: /aosp_15_r20/external/armnn/samples/PreImportMemorySample.cpp (revision 89c4ff92f2867872bb9e2354d150bf0c8c502810)
1*89c4ff92SAndroid Build Coastguard Worker //
2*89c4ff92SAndroid Build Coastguard Worker // Copyright © 2021 Arm Ltd and Contributors. All rights reserved.
3*89c4ff92SAndroid Build Coastguard Worker // SPDX-License-Identifier: MIT
4*89c4ff92SAndroid Build Coastguard Worker //
5*89c4ff92SAndroid Build Coastguard Worker 
6*89c4ff92SAndroid Build Coastguard Worker #include <armnn/ArmNN.hpp>
7*89c4ff92SAndroid Build Coastguard Worker 
8*89c4ff92SAndroid Build Coastguard Worker #include <iostream>
9*89c4ff92SAndroid Build Coastguard Worker 
10*89c4ff92SAndroid Build Coastguard Worker // A simple example application to show the usage of Memory Management Pre Importing of Inputs and Outputs. In this
11*89c4ff92SAndroid Build Coastguard Worker // sample, the users single input number is added to itself using an add layer and outputted to console as a number
12*89c4ff92SAndroid Build Coastguard Worker // that is double the input. The code does not use EnqueueWorkload but instead uses runtime->Execute
13*89c4ff92SAndroid Build Coastguard Worker 
main()14*89c4ff92SAndroid Build Coastguard Worker int main()
15*89c4ff92SAndroid Build Coastguard Worker {
16*89c4ff92SAndroid Build Coastguard Worker     using namespace armnn;
17*89c4ff92SAndroid Build Coastguard Worker 
18*89c4ff92SAndroid Build Coastguard Worker     float number;
19*89c4ff92SAndroid Build Coastguard Worker     std::cout << "Please enter a number: " << std::endl;
20*89c4ff92SAndroid Build Coastguard Worker     std::cin >> number;
21*89c4ff92SAndroid Build Coastguard Worker 
22*89c4ff92SAndroid Build Coastguard Worker     // Turn on logging to standard output
23*89c4ff92SAndroid Build Coastguard Worker     // This is useful in this sample so that users can learn more about what is going on
24*89c4ff92SAndroid Build Coastguard Worker     armnn::ConfigureLogging(true, false, LogSeverity::Info);
25*89c4ff92SAndroid Build Coastguard Worker 
26*89c4ff92SAndroid Build Coastguard Worker     armnn::IRuntime::CreationOptions options;
27*89c4ff92SAndroid Build Coastguard Worker     armnn::IRuntimePtr               runtime(armnn::IRuntime::Create(options));
28*89c4ff92SAndroid Build Coastguard Worker 
29*89c4ff92SAndroid Build Coastguard Worker     armnn::NetworkId   networkIdentifier1 = 0;
30*89c4ff92SAndroid Build Coastguard Worker 
31*89c4ff92SAndroid Build Coastguard Worker     armnn::INetworkPtr testNetwork(armnn::INetwork::Create());
32*89c4ff92SAndroid Build Coastguard Worker     auto inputLayer1 = testNetwork->AddInputLayer(0, "input 1 layer");
33*89c4ff92SAndroid Build Coastguard Worker     auto inputLayer2 = testNetwork->AddInputLayer(1, "input 2 layer");
34*89c4ff92SAndroid Build Coastguard Worker     ARMNN_NO_DEPRECATE_WARN_BEGIN
35*89c4ff92SAndroid Build Coastguard Worker     auto addLayer = testNetwork->AddAdditionLayer("add layer");
36*89c4ff92SAndroid Build Coastguard Worker     ARMNN_NO_DEPRECATE_WARN_END
37*89c4ff92SAndroid Build Coastguard Worker     auto outputLayer = testNetwork->AddOutputLayer(2, "output layer");
38*89c4ff92SAndroid Build Coastguard Worker 
39*89c4ff92SAndroid Build Coastguard Worker     // Set the tensors in the network.
40*89c4ff92SAndroid Build Coastguard Worker     TensorInfo tensorInfo{{4}, armnn::DataType::Float32};
41*89c4ff92SAndroid Build Coastguard Worker 
42*89c4ff92SAndroid Build Coastguard Worker     inputLayer1->GetOutputSlot(0).Connect(addLayer->GetInputSlot(0));
43*89c4ff92SAndroid Build Coastguard Worker     inputLayer1->GetOutputSlot(0).SetTensorInfo(tensorInfo);
44*89c4ff92SAndroid Build Coastguard Worker     inputLayer2->GetOutputSlot(0).Connect(addLayer->GetInputSlot(1));
45*89c4ff92SAndroid Build Coastguard Worker     inputLayer2->GetOutputSlot(0).SetTensorInfo(tensorInfo);
46*89c4ff92SAndroid Build Coastguard Worker 
47*89c4ff92SAndroid Build Coastguard Worker     addLayer->GetOutputSlot(0).Connect(outputLayer->GetInputSlot(0));
48*89c4ff92SAndroid Build Coastguard Worker     addLayer->GetOutputSlot(0).SetTensorInfo(tensorInfo);
49*89c4ff92SAndroid Build Coastguard Worker 
50*89c4ff92SAndroid Build Coastguard Worker     // Set preferred backend to CpuRef
51*89c4ff92SAndroid Build Coastguard Worker     std::vector<armnn::BackendId> backends = { armnn::Compute::CpuRef };
52*89c4ff92SAndroid Build Coastguard Worker 
53*89c4ff92SAndroid Build Coastguard Worker     // To hold an eventual error message if loading the network fails
54*89c4ff92SAndroid Build Coastguard Worker     std::string er;
55*89c4ff92SAndroid Build Coastguard Worker 
56*89c4ff92SAndroid Build Coastguard Worker     // Initialize network properties with asyncEnabled and MemorySources != MemorySource::Undefined
57*89c4ff92SAndroid Build Coastguard Worker     armnn::INetworkProperties networkProperties(true, MemorySource::Malloc, MemorySource::Malloc);
58*89c4ff92SAndroid Build Coastguard Worker 
59*89c4ff92SAndroid Build Coastguard Worker     // Optimize and Load the network into runtime
60*89c4ff92SAndroid Build Coastguard Worker     runtime->LoadNetwork(networkIdentifier1,
61*89c4ff92SAndroid Build Coastguard Worker                          Optimize(*testNetwork, backends, runtime->GetDeviceSpec()),
62*89c4ff92SAndroid Build Coastguard Worker                          er,
63*89c4ff92SAndroid Build Coastguard Worker                          networkProperties);
64*89c4ff92SAndroid Build Coastguard Worker 
65*89c4ff92SAndroid Build Coastguard Worker     // Create structures for input & output
66*89c4ff92SAndroid Build Coastguard Worker     std::vector<float> inputData1(4, number);
67*89c4ff92SAndroid Build Coastguard Worker     std::vector<float> inputData2(4, number);
68*89c4ff92SAndroid Build Coastguard Worker     ConstTensor inputTensor1(tensorInfo, inputData1.data());
69*89c4ff92SAndroid Build Coastguard Worker     ConstTensor inputTensor2(tensorInfo, inputData2.data());
70*89c4ff92SAndroid Build Coastguard Worker 
71*89c4ff92SAndroid Build Coastguard Worker     std::vector<float> outputData1(4);
72*89c4ff92SAndroid Build Coastguard Worker     Tensor outputTensor1{tensorInfo, outputData1.data()};
73*89c4ff92SAndroid Build Coastguard Worker 
74*89c4ff92SAndroid Build Coastguard Worker     // ImportInputs separates the importing and mapping of InputTensors from network execution.
75*89c4ff92SAndroid Build Coastguard Worker     // Allowing for a set of InputTensors to be imported and mapped once, but used in execution many times.
76*89c4ff92SAndroid Build Coastguard Worker     // ImportInputs is not thread safe and must not be used while other threads are calling Execute().
77*89c4ff92SAndroid Build Coastguard Worker     // Only compatible with AsyncEnabled networks
78*89c4ff92SAndroid Build Coastguard Worker 
79*89c4ff92SAndroid Build Coastguard Worker     // PreImport inputTensors giving pre-imported ids of 1 and 2
80*89c4ff92SAndroid Build Coastguard Worker     std::vector<ImportedInputId> importedInputVec = runtime->ImportInputs(networkIdentifier1,
81*89c4ff92SAndroid Build Coastguard Worker                                                                           {{0, inputTensor1}, {1, inputTensor2}});
82*89c4ff92SAndroid Build Coastguard Worker 
83*89c4ff92SAndroid Build Coastguard Worker     // Create a new unique WorkingMemHandle object. Create multiple handles if you wish to have
84*89c4ff92SAndroid Build Coastguard Worker     // overlapped Execution by calling this function from different threads.
85*89c4ff92SAndroid Build Coastguard Worker     auto memHandle = runtime->CreateWorkingMemHandle(networkIdentifier1);
86*89c4ff92SAndroid Build Coastguard Worker 
87*89c4ff92SAndroid Build Coastguard Worker     // Execute evaluates a network using input in inputTensors and outputs filled into outputTensors.
88*89c4ff92SAndroid Build Coastguard Worker     // This function performs a thread safe execution of the network. Returns once execution is complete.
89*89c4ff92SAndroid Build Coastguard Worker     // Will block until this and any other thread using the same workingMem object completes.
90*89c4ff92SAndroid Build Coastguard Worker     // Execute with PreImported inputTensor1 as well as Non-PreImported inputTensor2
91*89c4ff92SAndroid Build Coastguard Worker     runtime->Execute(*memHandle.get(), {}, {{2, outputTensor1}}, importedInputVec /* pre-imported ids */);
92*89c4ff92SAndroid Build Coastguard Worker 
93*89c4ff92SAndroid Build Coastguard Worker     // ImportOutputs separates the importing and mapping of OutputTensors from network execution.
94*89c4ff92SAndroid Build Coastguard Worker     // Allowing for a set of OutputTensors to be imported and mapped once, but used in execution many times.
95*89c4ff92SAndroid Build Coastguard Worker     // This function is not thread safe and must not be used while other threads are calling Execute().
96*89c4ff92SAndroid Build Coastguard Worker     // Only compatible with AsyncEnabled networks
97*89c4ff92SAndroid Build Coastguard Worker     // Provide layerBinding Id to outputTensor1
98*89c4ff92SAndroid Build Coastguard Worker     std::pair<LayerBindingId, class Tensor> output1{2, outputTensor1};
99*89c4ff92SAndroid Build Coastguard Worker     // PreImport outputTensor1
100*89c4ff92SAndroid Build Coastguard Worker     std::vector<ImportedOutputId> importedOutputVec = runtime->ImportOutputs(networkIdentifier1, {output1});
101*89c4ff92SAndroid Build Coastguard Worker 
102*89c4ff92SAndroid Build Coastguard Worker     // Execute with Non-PreImported inputTensor1 as well as PreImported inputTensor2
103*89c4ff92SAndroid Build Coastguard Worker     runtime->Execute(*memHandle.get(), {{0, inputTensor1}}, {{2, outputTensor1}}, {1 /* pre-imported id */});
104*89c4ff92SAndroid Build Coastguard Worker 
105*89c4ff92SAndroid Build Coastguard Worker     // Clear the previously PreImportedInput with the network Id and inputIds returned from ImportInputs()
106*89c4ff92SAndroid Build Coastguard Worker     // Note: This will happen automatically during destructor of armnn::LoadedNetwork
107*89c4ff92SAndroid Build Coastguard Worker     runtime->ClearImportedInputs(networkIdentifier1, importedInputVec);
108*89c4ff92SAndroid Build Coastguard Worker 
109*89c4ff92SAndroid Build Coastguard Worker     // Clear the previously PreImportedOutputs with the network Id and outputIds returned from ImportOutputs()
110*89c4ff92SAndroid Build Coastguard Worker     // Note: This will happen automatically during destructor of armnn::LoadedNetwork
111*89c4ff92SAndroid Build Coastguard Worker     runtime->ClearImportedOutputs(networkIdentifier1, importedOutputVec);
112*89c4ff92SAndroid Build Coastguard Worker 
113*89c4ff92SAndroid Build Coastguard Worker     // Execute with Non-PreImported inputTensor1, inputTensor2 and the PreImported outputTensor1
114*89c4ff92SAndroid Build Coastguard Worker     runtime->Execute(*memHandle.get(), {{0, inputTensor1}, {1, inputTensor2}}, {{2, outputTensor1}});
115*89c4ff92SAndroid Build Coastguard Worker 
116*89c4ff92SAndroid Build Coastguard Worker     std::cout << "Your number was " << outputData1.data()[0] << std::endl;
117*89c4ff92SAndroid Build Coastguard Worker 
118*89c4ff92SAndroid Build Coastguard Worker     return 0;
119*89c4ff92SAndroid Build Coastguard Worker }
120