From 9d7a332e76cf861bc91be4e68d031de67ea468ae Mon Sep 17 00:00:00 2001 From: Matthew Sloyan Date: Tue, 12 Jan 2021 16:19:43 +0000 Subject: IVGCVSW-5644 Add documentation for cache loaded network * Added ModelOptions documentation to CLBackendModelContext * Improved options descriptions in ExecuteNetworkProgramOptions.cpp Signed-off-by: Matthew Sloyan Change-Id: I14f0c8bb4f299809b89f49c616b691e2f7956d5b --- src/backends/cl/ClBackendModelContext.hpp | 9 +++++++++ tests/ExecuteNetwork/ExecuteNetworkProgramOptions.cpp | 8 ++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/src/backends/cl/ClBackendModelContext.hpp b/src/backends/cl/ClBackendModelContext.hpp index c84cdbbfcf..e7a26cd688 100644 --- a/src/backends/cl/ClBackendModelContext.hpp +++ b/src/backends/cl/ClBackendModelContext.hpp @@ -16,6 +16,15 @@ namespace armnn /// - "FastMathEnabled"\n /// Using the fast_math flag can lead to performance improvements in fp32 and fp16 layers but may result in\n /// results with reduced or different precision. The fast_math flag will not have any effect on int8 performance. +/// - "SaveCachedNetwork"\n +/// Using the save_cached_network flag enables saving the cached network\n +/// to a file given with the cached_network_file_path option. +/// - "CachedNetworkFilePath"\n +/// If the cached_network_file_path is a valid file and the save_cached_network flag is present\n +/// then the cached network will be saved to the given file.\n +/// If the cached_network_file_path is a valid file and the save_cached_network flag is not present\n +/// then the cached network will be loaded from the given file.\n +/// This will remove the time taken for initial compilation of kernels and speed up the first execution. class ClBackendModelContext : public IBackendModelContext { public: diff --git a/tests/ExecuteNetwork/ExecuteNetworkProgramOptions.cpp b/tests/ExecuteNetwork/ExecuteNetworkProgramOptions.cpp index 002a3d1d80..a080e57d0c 100644 --- a/tests/ExecuteNetwork/ExecuteNetworkProgramOptions.cpp +++ b/tests/ExecuteNetwork/ExecuteNetworkProgramOptions.cpp @@ -277,13 +277,17 @@ ProgramOptions::ProgramOptions() : m_CxxOptions{"ExecuteNetwork", cxxopts::value(m_ExNetParams.m_EnableFastMath)->default_value("false")->implicit_value("true")) ("save-cached-network", - "Enables saving of the cached network. " + "Enables saving of the cached network to a file given with the cached-network-filepath option. " "See also --cached-network-filepath", cxxopts::value(m_ExNetParams.m_SaveCachedNetwork) ->default_value("false")->implicit_value("true")) ("cached-network-filepath", - "If non-empty, the given file will be used to load/save cached network.", + "If non-empty, the given file will be used to load/save the cached network. " + "If save-cached-network is given then the cached network will be saved to the given file. " + "To save the cached network a file must already exist. " + "If save-cached-network is not given then the cached network will be loaded from the given file. " + "This will remove initial compilation time of kernels and speed up the first execution.", cxxopts::value(m_ExNetParams.m_CachedNetworkFilePath)->default_value("")) ("fp16-turbo-mode", -- cgit v1.2.1