[OV2.0] Preprocessing documentation (#10451)

* [OV2.0] Preprocessing documentation - first draft * Small update * Added ov::Layout overview * Fix code style * Preprocessing details - ~50% done * Corrected links * Fixed comments, added more docs * Minor updates * Couple more links * Fixed comments * Remove 'future' link
2022-02-21 19:20:23 +03:00
parent 65d1575642
commit f82533005b
14 changed files with 1181 additions and 57 deletions
@@ -0,0 +1,55 @@
+// Copyright (C) 2018-2022 Intel Corporation
+// SPDX-License-Identifier: Apache-2.0
+//
+#include <openvino/core/layout.hpp>
+
+int main() {
+ ov::Layout layout;
+ //! [ov:layout:simple]
+ layout = ov::Layout("NHWC");
+ //! [ov:layout:simple]
+ //! [ov:layout:complex]
+ // Each dimension has name separated by comma, layout is wrapped with square brackets
+ layout = ov::Layout("[time,temperature,humidity]");
+ //! [ov:layout:complex]
+ //! [ov:layout:partially_defined]
+ // First dimension is batch, 4th is 'channels'. Others are not important for us
+ layout = ov::Layout("N??C");
+ // Or the same using advanced syntax
+ layout = ov::Layout("[n,?,?,c]");
+ //! [ov:layout:partially_defined]
+ //! [ov:layout:dynamic]
+ // First dimension is 'batch' others are whatever
+ layout = ov::Layout("N...");
+
+ // Second dimension is 'channels' others are whatever
+ layout = ov::Layout("?C...");
+
+ // Last dimension is 'channels' others are whatever
+ layout = ov::Layout("...C");
+ //! [ov:layout:dynamic]
+
+ //! [ov:layout:predefined]
+ // returns 0 for batch
+ ov::layout::batch_idx("NCDHW");
+
+ // returns 1 for channels
+ ov::layout::channels_idx("NCDHW");
+
+ // returns 2 for depth
+ ov::layout::depth_idx("NCDHW");
+
+ // returns -2 for height
+ ov::layout::height_idx("...HW");
+
+ // returns -1 for width
+ ov::layout::width_idx("...HW");
+ //! [ov:layout:predefined]
+
+ //! [ov:layout:dump]
+ layout = ov::Layout("NCHW");
+ std::cout << layout.to_string(); // prints [N,C,H,W]
+ //! [ov:layout:dump]
+
+ return 0;
+}