From d813bab10bb4fe954fa0e962e1402ed1377617da Mon Sep 17 00:00:00 2001 From: Sheri Zhang Date: Fri, 30 Apr 2021 16:53:41 +0100 Subject: Restructure documentation The documentation has been restructured for better grouping and readability. Resolves: COMPMID-4198 Signed-off-by: Sheri Zhang Change-Id: I8c8bc77f0aab8d63f1659f2235dbab634422a68c Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/5568 Tested-by: Georgios Pinitas Comments-Addressed: Arm Jenkins --- docs/user_guide/data_layout.dox | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/user_guide/data_layout.dox (limited to 'docs/user_guide/data_layout.dox') diff --git a/docs/user_guide/data_layout.dox b/docs/user_guide/data_layout.dox new file mode 100644 index 0000000000..48f15acd63 --- /dev/null +++ b/docs/user_guide/data_layout.dox @@ -0,0 +1,41 @@ +/// +/// Copyright (c) 2021 Arm Limited. +/// +/// SPDX-License-Identifier: MIT +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy +/// of this software and associated documentation files (the "Software"), to +/// deal in the Software without restriction, including without limitation the +/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +/// sell copies of the Software, and to permit persons to whom the Software is +/// furnished to do so, subject to the following conditions: +/// +/// The above copyright notice and this permission notice shall be included in all +/// copies or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +/// SOFTWARE. +/// + +namespace arm_compute +{ +/** +@page data_layout_support Data Layout Support + +@section data_layout_support_supported_data_layout Supported Data Layouts + +Compute Library supports the follwing data layouts and +the right-most letter represents the fastest changing dimension: + +- NHWC: The native layout of Compute Library that delivers the best performance where channels are in the fastest changing dimension +- NCHW: Legacy layout where width is in the fastest changing dimension + +, where N = batch, C = channel, H = height, W = width. + +*/ +} // namespace -- cgit v1.2.1