diff options
| author | Sang-Hoon Park <sang-hoon.park@arm.com> | 2021-04-23 14:00:33 +0100 |
|---|---|---|
| committer | Georgios Pinitas <georgios.pinitas@arm.com> | 2021-05-04 14:06:33 +0000 |
| commit | 0ec58215bf5322d370dbc7c0a7f3ced05af2174f (patch) | |
| tree | 33a6fe4373ba10d5fc192ddda5475d26092c7859 | |
| parent | 1fac03717dab014fd202ea85a8f05b3dd475cb3c (diff) | |
| download | ComputeLibrary-0ec58215bf5322d370dbc7c0a7f3ced05af2174f.tar.gz | |
Add Queue to API documentation
Change-Id: If53338edb3e34e389b3905a6c08ebc3797b9ce25
Signed-off-by: Sang-Hoon Park <sang-hoon.park@arm.com>
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/5554
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Michele Di Giorgio <michele.digiorgio@arm.com>
Reviewed-by: Georgios Pinitas <georgios.pinitas@arm.com>
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
| -rw-r--r-- | docs/08_api.dox | 10 |
1 files changed, 10 insertions, 0 deletions
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 |