blob: ae69bbf457de4941ed8fdf8dfe9f716b449a6be5 [file] [log] [blame]
Sheri Zhangd813bab2021-04-30 16:53:41 +01001///
2/// Copyright (c) 2021 Arm Limited.
3///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
24
25namespace arm_compute
26{
27/**
28@page data_layout_support Data Layout Support
29
30@section data_layout_support_supported_data_layout Supported Data Layouts
31
Jakub Sujakee301b32021-06-04 09:46:08 +010032Compute Library supports the following data layouts and
Sheri Zhangd813bab2021-04-30 16:53:41 +010033the right-most letter represents the fastest changing dimension:
34
35- NHWC: The native layout of Compute Library that delivers the best performance where channels are in the fastest changing dimension
36- NCHW: Legacy layout where width is in the fastest changing dimension
Sheri Zhang5dda2172021-10-15 19:54:17 +010037- NDHWC: New data layout for supporting 3D operators
Sheri Zhangd813bab2021-04-30 16:53:41 +010038
Sheri Zhang5dda2172021-10-15 19:54:17 +010039, where N = batch, C = channel, H = height, W = width, D = depth.
Sheri Zhangd813bab2021-04-30 16:53:41 +010040
41*/
42} // namespace