From ae050524109f1ce827962665436ef7430f2ac479 Mon Sep 17 00:00:00 2001 From: David Monahan Date: Wed, 22 Mar 2023 16:48:58 +0000 Subject: IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub. * Updating Doxygen documentation for 23.02 release. Signed-off-by: David Monahan Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82 --- 23.02/classarmnn_1_1_cl_context_serializer.xhtml | 73 ++++++++++++++++-------- 1 file changed, 49 insertions(+), 24 deletions(-) (limited to '23.02/classarmnn_1_1_cl_context_serializer.xhtml') diff --git a/23.02/classarmnn_1_1_cl_context_serializer.xhtml b/23.02/classarmnn_1_1_cl_context_serializer.xhtml index 36c58553b7..9fe1b6100f 100644 --- a/23.02/classarmnn_1_1_cl_context_serializer.xhtml +++ b/23.02/classarmnn_1_1_cl_context_serializer.xhtml @@ -8,7 +8,7 @@ - + ArmNN: ClContextSerializer Class Reference @@ -19,9 +19,6 @@ - @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); - + + @@ -51,18 +49,21 @@ - + +/* @license-end */
@@ -76,7 +77,9 @@ $(function() {
@@ -111,10 +114,10 @@ Public Member Functions  ~ClContextSerializer ()=default   void Serialize (const arm_compute::CLCompileContext &clCompileContext) - Serializes the CLCompileContext built-in programs. More...
+ Serializes the CLCompileContext built-in programs. More...
  bool SaveSerializedToStream (std::ostream &stream) - Serializes the ClContext to the stream. More...
+ Serializes the ClContext to the stream. More...
 

Detailed Description

@@ -198,11 +201,12 @@ Public Member Functions
Returns
true if ClContext is Serialized to the Stream, false otherwise

Definition at line 49 of file ClContextSerializer.cpp.

- -

References armnn::numeric_cast().

- -

Referenced by ClWorkloadFactory::AfterWorkloadsCreated().

-
50 {
51  // Write to a stream
52  auto bytesToWrite = armnn::numeric_cast<std::streamsize>(m_FlatBufferBuilder.GetSize());
53  stream.write(reinterpret_cast<const char*>(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);
54  return !stream.bad();
55 }
armnn::numeric_cast
std::enable_if_t< std::is_unsigned< Source >::value &&std::is_unsigned< Dest >::value, Dest > numeric_cast(Source source)
Definition: NumericCast.hpp:35
+
50 {
+
51  // Write to a stream
+
52  auto bytesToWrite = armnn::numeric_cast<std::streamsize>(m_FlatBufferBuilder.GetSize());
+
53  stream.write(reinterpret_cast<const char*>(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);
+
54  return !stream.bad();
+
55 }
@@ -231,15 +235,33 @@ Public Member Functions

Definition at line 23 of file ClContextSerializer.cpp.

- +
24 {
+
25  // Get map of built programs from clCompileContext
+
26  std::map<std::string, cl::Program> builtProgramsMap = clCompileContext.get_built_programs();
+
27  if (builtProgramsMap.empty())
+
28  {
+
29  ARMNN_LOG(warning) << "There are no built programs to be serialised.";
+
30  return;
+
31  }
+
32 
+
33  // Create Flatbuffer CL Programs
+
34  std::vector<flatbuffers::Offset<armnn::Program>> clPrograms;
+
35  for(const auto& program : builtProgramsMap)
+
36  {
+
37  std::vector<std::vector<uint8_t>> binaries = program.second.getInfo<CL_PROGRAM_BINARIES>();
+
38  clPrograms.push_back(CreateProgram(m_FlatBufferBuilder,
+
39  m_FlatBufferBuilder.CreateString(program.first),
+
40  m_FlatBufferBuilder.CreateVector(binaries[0])));
+
41  }
+
42 
+
43  // Create Flatbuffer CLContext
+
44  auto clContext = CreateClContext(m_FlatBufferBuilder, m_FlatBufferBuilder.CreateVector(clPrograms));
+
45 
+
46  m_FlatBufferBuilder.Finish(clContext);
+
47 }
+

References ARMNN_LOG, armnn::CreateClContext(), armnn::CreateProgram(), and armnn::warning.

-

Referenced by ClWorkloadFactory::AfterWorkloadsCreated().

-
24 {
25  // Get map of built programs from clCompileContext
26  std::map<std::string, cl::Program> builtProgramsMap = clCompileContext.get_built_programs();
27  if (builtProgramsMap.empty())
28  {
29  ARMNN_LOG(warning) << "There are no built programs to be serialised.";
30  return;
31  }
32 
33  // Create Flatbuffer CL Programs
34  std::vector<flatbuffers::Offset<armnn::Program>> clPrograms;
35  for(const auto& program : builtProgramsMap)
36  {
37  std::vector<std::vector<uint8_t>> binaries = program.second.getInfo<CL_PROGRAM_BINARIES>();
38  clPrograms.push_back(CreateProgram(m_FlatBufferBuilder,
39  m_FlatBufferBuilder.CreateString(program.first),
40  m_FlatBufferBuilder.CreateVector(binaries[0])));
41  }
42 
43  // Create Flatbuffer CLContext
44  auto clContext = CreateClContext(m_FlatBufferBuilder, m_FlatBufferBuilder.CreateVector(clPrograms));
45 
46  m_FlatBufferBuilder.Finish(clContext);
47 }
armnn::CreateProgram
flatbuffers::Offset< Program > CreateProgram(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::String > name=0, flatbuffers::Offset< flatbuffers::Vector< uint8_t >> binary=0)
Definition: ClContextSchema_generated.h:118
-
ARMNN_LOG
#define ARMNN_LOG(severity)
Definition: Logging.hpp:212
- -
armnn::CreateClContext
flatbuffers::Offset< ClContext > CreateClContext(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::Vector< flatbuffers::Offset< armnn::Program >>> programs=0)
Definition: ClContextSchema_generated.h:57
-
The documentation for this class was generated from the following files: +
armnn::CreateProgram
flatbuffers::Offset< Program > CreateProgram(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::String > name=0, flatbuffers::Offset< flatbuffers::Vector< uint8_t >> binary=0)
Definition: ClContextSchema_generated.h:118
+
armnn::CreateClContext
flatbuffers::Offset< ClContext > CreateClContext(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::Vector< flatbuffers::Offset< armnn::Program >>> programs=0)
Definition: ClContextSchema_generated.h:57
+
ARMNN_LOG
#define ARMNN_LOG(severity)
Definition: Logging.hpp:212
-- cgit v1.2.1