From 0ec58215bf5322d370dbc7c0a7f3ced05af2174f Mon Sep 17 00:00:00 2001 From: Sang-Hoon Park Date: Fri, 23 Apr 2021 14:00:33 +0100 Subject: Add Queue to API documentation Change-Id: If53338edb3e34e389b3905a6c08ebc3797b9ce25 Signed-off-by: Sang-Hoon Park Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/5554 Tested-by: Arm Jenkins Reviewed-by: Michele Di Giorgio Reviewed-by: Georgios Pinitas Comments-Addressed: Arm Jenkins --- docs/08_api.dox | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/08_api.dox b/docs/08_api.dox index 29d31c831d..39282046a9 100644 --- a/docs/08_api.dox +++ b/docs/08_api.dox @@ -101,6 +101,16 @@ to extract (@ref AclGetClMem) the internal OpenCL memory object. As Tensors can reside in different memory spaces, @ref AclMapTensor and @ref AclUnmapTensor entrypoints are provided to map Tensors in and out of the host memory system, respectively. +@subsection api_objects_queue AclQueue or Queue + +AclQueue acts as a runtime aggregate service. It provides facilities to schedule +and execute operators using underlying hardware. It also contains services like +tuning mechanisms (e.g., Local workgroup size tuning for OpenCL) that can be specified +during operator execution. + +@note To enable interoperability with OpenCL, additional entrypoints are provided +to extract (@ref AclGetClQueue) or set (@ref AclSetClQueue) the internal OpenCL queue. + @section api_internal Internal @subsection api_internal_operator_vs_kernels Operators vs Kernels -- cgit v1.2.1