Unified conv3D API + support for all data types. (#133)

* Convolution ND

* Code unification across dimensions for generating tensor descriptors.
* Example
* Instances

* Move convnd f32 instance file to comply with repo structure.

* Conv 1D tensor layouts.

* Formatting and use ReferenceConv

* Reference ConvFwd supporting 1D and 2D convolution.

* Debug printing TensorLayout name.

* Conv fwd 1D instance f32

* Refactor conv ND example.

Needed to support various conv dimensio.

Needed to support various conv dimensions

* Rename conv nd example director to prevent conflicts.

* Refactor some common utility to single file.

Plus some tests.

* Refactor GetHostTensorDescriptor + UT.

* Add 1D test case.

* Test reference convolution 1d/2d

* Remove some leftovers.

* Fix convolution example error for 1D

* Refactor test check errors utility function.

* Test Conv2D Fwd XDL

* More UT for 1D case.

* Parameterize input & weight initializers.

* Rename example to prevent conflicts.

* Split convnd instance into separate files for 1d/2d

* Address review comments.

* Fix data type for flops/gbytes calculations.

* Assign example number 11.

* 3D cases for convolution utility functions.

* 3D reference convolution.

* Add support for 3D convolution.

* Check for inputs bigger than  2GB.

* Formatting

* Support for bf16/f16/f32/i8 - conv instances + UT.

* Use check_err from test_util.hpp.

* Split convnd test into separate files for each dim.

* Fix data generation and use proper instances.

* Formatting

* Skip tensor initialization if not necessary.

* Fix CMakefiles.

* Remove redundant conv2d_fwd test.

* Lower problem size for conv3D UT.

* 3D case for convnd example.

* Remove leftovers after merge.

* Add Conv Specialization string to GetTypeString

* Skip instance causing numerical errors.

* Small fixes.

* Remove redundant includes.

* Fix namespace name error.

* Script for automatic testing and logging convolution fwd UTs

* Comment out numactl cmd.

* Refine weights initalization and relax rtol for fp16

* Fix weights initialization for int8.

* Add type_convert when store output in ref conv 1D.

* Get back old conv2d_fwd_xdl operation.

* Silence conv debug print.

* format

* clean

* clean

* Fix merge.

* Fix namespace for check_err

Co-authored-by: Adam Osewski <aosewski@amd.com>
Co-authored-by: Chao Liu <chao.liu2@amd.com>

test/conv_util/conv_util.cpp

@@ -5,33 +5,10 @@
 #include "config.hpp"
 #include "conv_utils.hpp"
 #include "tensor_layout.hpp"
+#include "test_util.hpp"
 
 namespace {
 
-template <typename T>
-bool cmp_vec(const std::vector<T>& out, const std::vector<T>& ref, const std::string& msg)
-{
-    if(out.size() != ref.size())
-    {
-        std::cout << "out.size() != ref.size(), :" << out.size() << " != " << ref.size()
-                  << std::endl
-                  << msg << std::endl;
-        return false;
-    }
-
-    for(std::size_t i = 0; i < ref.size(); ++i)
-    {
-        if(out[i] != ref[i])
-        {
-            std::cout << "out[" << i << "] != ref[" << i << "]: " << out[i] << "!=" << ref[i]
-                      << std::endl
-                      << msg << std::endl;
-            return false;
-        }
-    }
-    return true;
-}
-
 bool TestConvParams_GetOutputSpatialLengths()
 {
     bool res{true};
@@ -43,26 +20,26 @@ bool TestConvParams_GetOutputSpatialLengths()
     // padding {{1,1}, {1,1}}
     ck::conv_util::ConvParams conv_params;
     std::vector<ck::index_t> out_spatial_len = conv_params.GetOutputSpatialLengths();
-    res                                      = cmp_vec(out_spatial_len,
-                  std::vector<ck::index_t>{36, 36},
-                  "Error: ConvParams 2D default constructor.");
+    res                                      = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{36, 36},
+                          "Error: ConvParams 2D default constructor.");
 
     conv_params.conv_filter_strides = std::vector<ck::index_t>{1, 1};
     out_spatial_len                 = conv_params.GetOutputSpatialLengths();
-    res                             = cmp_vec(
+    res                             = test::check_err(
         out_spatial_len, std::vector<ck::index_t>{71, 71}, "Error: ConvParams 2D stride {1,1}.");
 
     conv_params.conv_filter_strides = std::vector<ck::index_t>{2, 2};
     conv_params.input_left_pads     = std::vector<ck::index_t>{2, 2};
     conv_params.input_right_pads    = std::vector<ck::index_t>{2, 2};
     out_spatial_len                 = conv_params.GetOutputSpatialLengths();
-    res                             = cmp_vec(out_spatial_len,
-                  std::vector<ck::index_t>{37, 37},
-                  "Error: ConvParams 2D padding left/right {2,2}.");
+    res                             = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{37, 37},
+                          "Error: ConvParams 2D padding left/right {2,2}.");
 
     conv_params.conv_filter_dilations = std::vector<ck::index_t>{2, 2};
     out_spatial_len                   = conv_params.GetOutputSpatialLengths();
-    res                               = cmp_vec(
+    res                               = test::check_err(
         out_spatial_len, std::vector<ck::index_t>{36, 36}, "Error: ConvParams 2D dilation {2,2}.");
 
     conv_params.conv_filter_strides   = std::vector<ck::index_t>{3, 3};
@@ -70,9 +47,9 @@ bool TestConvParams_GetOutputSpatialLengths()
     conv_params.input_right_pads      = std::vector<ck::index_t>{1, 1};
     conv_params.conv_filter_dilations = std::vector<ck::index_t>{2, 2};
     out_spatial_len                   = conv_params.GetOutputSpatialLengths();
-    res                               = cmp_vec(out_spatial_len,
-                  std::vector<ck::index_t>{23, 23},
-                  "Error: ConvParams 2D strides{3,3}, padding {1,1}, dilations {2,2}.");
+    res                               = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{23, 23},
+                          "Error: ConvParams 2D strides{3,3}, padding {1,1}, dilations {2,2}.");
 
     // -------------------------- 1D ------------------------------------
     conv_params.num_dim_spatial        = 1;
@@ -84,25 +61,24 @@ bool TestConvParams_GetOutputSpatialLengths()
     conv_params.input_right_pads       = std::vector<ck::index_t>{1};
 
     out_spatial_len = conv_params.GetOutputSpatialLengths();
-    res             = cmp_vec(
-        out_spatial_len, std::vector<ck::index_t>{36}, "Error: ConvParams 1D default constructor.");
+    res = test::check_err(out_spatial_len, std::vector<ck::index_t>{36}, "Error: ConvParams 1D.");
 
     conv_params.conv_filter_strides = std::vector<ck::index_t>{1, 1};
     out_spatial_len                 = conv_params.GetOutputSpatialLengths();
-    res =
-        cmp_vec(out_spatial_len, std::vector<ck::index_t>{71}, "Error: ConvParams 1D stride {1}.");
+    res                             = test::check_err(
+        out_spatial_len, std::vector<ck::index_t>{71}, "Error: ConvParams 1D stride {1}.");
 
     conv_params.conv_filter_strides = std::vector<ck::index_t>{2};
     conv_params.input_left_pads     = std::vector<ck::index_t>{2};
     conv_params.input_right_pads    = std::vector<ck::index_t>{2};
     out_spatial_len                 = conv_params.GetOutputSpatialLengths();
-    res                             = cmp_vec(out_spatial_len,
-                  std::vector<ck::index_t>{37},
-                  "Error: ConvParams 1D padding left/right {2}.");
+    res                             = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{37},
+                          "Error: ConvParams 1D padding left/right {2}.");
 
     conv_params.conv_filter_dilations = std::vector<ck::index_t>{2};
     out_spatial_len                   = conv_params.GetOutputSpatialLengths();
-    res                               = cmp_vec(
+    res                               = test::check_err(
         out_spatial_len, std::vector<ck::index_t>{36}, "Error: ConvParams 1D dilation {2}.");
 
     conv_params.conv_filter_strides   = std::vector<ck::index_t>{3};
@@ -110,9 +86,52 @@ bool TestConvParams_GetOutputSpatialLengths()
     conv_params.input_right_pads      = std::vector<ck::index_t>{1};
     conv_params.conv_filter_dilations = std::vector<ck::index_t>{2};
     out_spatial_len                   = conv_params.GetOutputSpatialLengths();
-    res                               = cmp_vec(out_spatial_len,
-                  std::vector<ck::index_t>{23},
-                  "Error: ConvParams 1D strides{3}, padding {1}, dilations {2}.");
+    res                               = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{23},
+                          "Error: ConvParams 1D strides{3}, padding {1}, dilations {2}.");
+
+    // -------------------------- 3D ------------------------------------
+    conv_params.num_dim_spatial        = 3;
+    conv_params.filter_spatial_lengths = std::vector<ck::index_t>{3, 3, 3};
+    conv_params.input_spatial_lengths  = std::vector<ck::index_t>{71, 71, 71};
+    conv_params.conv_filter_strides    = std::vector<ck::index_t>{2, 2, 2};
+    conv_params.conv_filter_dilations  = std::vector<ck::index_t>{1, 1, 1};
+    conv_params.input_left_pads        = std::vector<ck::index_t>{1, 1, 1};
+    conv_params.input_right_pads       = std::vector<ck::index_t>{1, 1, 1};
+
+    out_spatial_len = conv_params.GetOutputSpatialLengths();
+    res             = test::check_err(
+        out_spatial_len, std::vector<ck::index_t>{36, 36, 36}, "Error: ConvParams 3D.");
+
+    conv_params.conv_filter_strides = std::vector<ck::index_t>{1, 1, 1};
+    out_spatial_len                 = conv_params.GetOutputSpatialLengths();
+    res                             = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{71, 71, 71},
+                          "Error: ConvParams 3D stride {1, 1, 1}.");
+
+    conv_params.conv_filter_strides = std::vector<ck::index_t>{2, 2, 2};
+    conv_params.input_left_pads     = std::vector<ck::index_t>{2, 2, 2};
+    conv_params.input_right_pads    = std::vector<ck::index_t>{2, 2, 2};
+    out_spatial_len                 = conv_params.GetOutputSpatialLengths();
+    res                             = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{37, 37, 37},
+                          "Error: ConvParams 3D padding left/right {2, 2, 2}.");
+
+    conv_params.conv_filter_dilations = std::vector<ck::index_t>{2, 2, 2};
+    out_spatial_len                   = conv_params.GetOutputSpatialLengths();
+    res                               = test::check_err(out_spatial_len,
+                          std::vector<ck::index_t>{36, 36, 36},
+                          "Error: ConvParams 3D dilation {2, 2, 2}.");
+
+    conv_params.conv_filter_strides   = std::vector<ck::index_t>{3, 3, 3};
+    conv_params.input_left_pads       = std::vector<ck::index_t>{1, 1, 1};
+    conv_params.input_right_pads      = std::vector<ck::index_t>{1, 1, 1};
+    conv_params.conv_filter_dilations = std::vector<ck::index_t>{2, 2, 2};
+    out_spatial_len                   = conv_params.GetOutputSpatialLengths();
+    res                               = test::check_err(
+        out_spatial_len,
+        std::vector<ck::index_t>{23, 23, 23},
+        "Error: ConvParams 3D strides{3, 3, 3}, padding {1, 1, 1}, dilations {2, 2, 2}.");
 
     return res;
 }
@@ -123,23 +142,44 @@ bool TestGetHostTensorDescriptor()
     namespace tl = ck::tensor_layout::convolution;
     std::vector<std::size_t> dims{2, 3, 4, 5};
     HostTensorDescriptor h = ck::conv_util::GetHostTensorDescriptor(dims, tl::NHWC{});
-    res = cmp_vec(h.GetLengths(), {2, 3, 4, 5}, "Error: wrong NHWC dimensions lengths!");
-    res =
-        cmp_vec(h.GetStrides(), {3 * 4 * 5, 1, 3 * 5, 3}, "Error: wrong NHWC dimensions strides!");
+    res = test::check_err(h.GetLengths(), {2, 3, 4, 5}, "Error: wrong NHWC dimensions lengths!");
+    res = test::check_err(
+        h.GetStrides(), {3 * 4 * 5, 1, 3 * 5, 3}, "Error: wrong NHWC dimensions strides!");
 
     h   = ck::conv_util::GetHostTensorDescriptor(dims, tl::NCHW{});
-    res = cmp_vec(h.GetLengths(), {2, 3, 4, 5}, "Error: wrong NCHW dimensions lengths!");
-    res =
-        cmp_vec(h.GetStrides(), {3 * 4 * 5, 4 * 5, 5, 1}, "Error: wrong NCHW dimensions strides!");
+    res = test::check_err(h.GetLengths(), {2, 3, 4, 5}, "Error: wrong NCHW dimensions lengths!");
+    res = test::check_err(
+        h.GetStrides(), {3 * 4 * 5, 4 * 5, 5, 1}, "Error: wrong NCHW dimensions strides!");
 
     dims = std::vector<std::size_t>{2, 3, 4};
     h    = ck::conv_util::GetHostTensorDescriptor(dims, tl::NWC{});
-    res  = cmp_vec(h.GetLengths(), {2, 3, 4}, "Error: wrong NWC dimensions lengths!");
-    res  = cmp_vec(h.GetStrides(), {3 * 4, 1, 3}, "Error: wrong NWC dimensions strides!");
+    res  = test::check_err(h.GetLengths(), {2, 3, 4}, "Error: wrong NWC dimensions lengths!");
+    res  = test::check_err(h.GetStrides(), {3 * 4, 1, 3}, "Error: wrong NWC dimensions strides!");
 
     h   = ck::conv_util::GetHostTensorDescriptor(dims, tl::NCW{});
-    res = cmp_vec(h.GetLengths(), {2, 3, 4}, "Error: wrong NCW dimensions lengths!");
-    res = cmp_vec(h.GetStrides(), {3 * 4, 4, 1}, "Error: wrong NCW dimensions strides!");
+    res = test::check_err(h.GetLengths(), {2, 3, 4}, "Error: wrong NCW dimensions lengths!");
+    res = test::check_err(h.GetStrides(), {3 * 4, 4, 1}, "Error: wrong NCW dimensions strides!");
+
+    dims = std::vector<std::size_t>{2, 3, 4, 5, 6};
+    h    = ck::conv_util::GetHostTensorDescriptor(dims, tl::NDHWC{});
+    res  = test::check_err(h.GetLengths(), dims, "Error: wrong NDHWC dimensions lengths!");
+    res  = test::check_err(h.GetStrides(),
+                          {3 * 4 * 5 * 6, // N
+                           1,             // C
+                           3 * 5 * 6,     // D
+                           3 * 6,         // H
+                           3},            // W
+                          "Error: wrong NDHWC dimensions strides!");
+
+    h   = ck::conv_util::GetHostTensorDescriptor(dims, tl::NCDHW{});
+    res = test::check_err(h.GetLengths(), dims, "Error: wrong NCDHW dimensions lengths!");
+    res = test::check_err(h.GetStrides(),
+                          {3 * 4 * 5 * 6, // N
+                           4 * 5 * 6,     // C
+                           5 * 6,         // D
+                           6,             // H
+                           1},            // W
+                          "Error: wrong NCDHW dimensions strides!");
 
     return res;
 }