Respond to comments

- Check that TensorDim < 3 using yaml returns: .
- Rename some things and remove copypasta

Author: Hugh Delaney

include/ur_api.h

@@ -9585,7 +9585,7 @@ urEnqueueNativeCommandExp(
 #if !defined(__GNUC__)
 #pragma endregion
 #endif
-// Intel 'oneAPI' Unified Runtime Experimental API for enqueuing work through native APIs
+// Intel 'oneAPI' Unified Runtime Experimental API for mapping tensor objects
 #if !defined(__GNUC__)
 #pragma region tensor map(experimental)
 #endif
@@ -9706,6 +9706,8 @@ typedef enum ur_exp_tensor_map_oob_fill_flag_t {
 ///         + `NULL == PixelBoxUpperCorner`
 ///         + `NULL == ElementStrides`
 ///         + `NULL == hTensorMap`
+///     - ::UR_RESULT_ERROR_INVALID_ARGUMENT
+///         + `TensorRank < 3`
 UR_APIEXPORT ur_result_t UR_APICALL
 urTensorMapEncodeIm2ColExp(
     ur_device_handle_t hDevice,                         ///< [in] Handle of the device object.
@@ -9715,18 +9717,18 @@ urTensorMapEncodeIm2ColExp(
     const uint64_t *GlobalDim,                          ///< [in] Array containing tensor size (number of elements) along each of
                                                         ///< the TensorRank dimensions.
     const uint64_t *GlobalStrides,                      ///< [in] Array containing stride size (in bytes) along each of the
-                                                        ///< tensorRank - 1 dimensions.
+                                                        ///< TensorRank - 1 dimensions.
     const int *PixelBoxLowerCorner,                     ///< [in] Array containing DHW dimensions of lower box corner.
     const int *PixelBoxUpperCorner,                     ///< [in] Array containing DHW dimensions of upper box corner.
     uint32_t ChannelsPerPixel,                          ///< [in] Number of channels per pixel.
     uint32_t PixelsPerColumn,                           ///< [in] Number of pixels per column.
-    const uint32_t *ElementStrides,                     ///< [in] Array containing traversal stride in each of the tensorRank
+    const uint32_t *ElementStrides,                     ///< [in] Array containing traversal stride in each of the TensorRank
                                                         ///< dimensions.
     ur_exp_tensor_map_interleave_flags_t Interleave,    ///< [in] Type of interleaved layout the tensor addresses
     ur_exp_tensor_map_swizzle_flags_t Swizzle,          ///< [in] Bank swizzling pattern inside shared memory
     ur_exp_tensor_map_l2_promotion_flags_t L2Promotion, ///< [in] L2 promotion size.
-    ur_exp_tensor_map_oob_fill_flags_t OobFill,         ///< [in] Indicate whether zero or special NaN constant will be used to
-                                                        ///< fill out-of-bound elements.
+    ur_exp_tensor_map_oob_fill_flags_t OobFill,         ///< [in] Indicates whether zero or special NaN constant will be used to
+                                                        ///< fill out-of-bounds elements.
     ur_exp_tensor_map_handle_t *hTensorMap              ///< [out] Handle of the tensor map object.
 );
 
@@ -9756,6 +9758,8 @@ urTensorMapEncodeIm2ColExp(
 ///         + `NULL == BoxDim`
 ///         + `NULL == ElementStrides`
 ///         + `NULL == hTensorMap`
+///     - ::UR_RESULT_ERROR_INVALID_ARGUMENT
+///         + `TensorRank < 3`
 UR_APIEXPORT ur_result_t UR_APICALL
 urTensorMapEncodeTiledExp(
     ur_device_handle_t hDevice,                         ///< [in] Handle of the device object.
@@ -9765,17 +9769,17 @@ urTensorMapEncodeTiledExp(
     const uint64_t *GlobalDim,                          ///< [in] Array containing tensor size (number of elements) along each of
                                                         ///< the TensorRank dimensions.
     const uint64_t *GlobalStrides,                      ///< [in] Array containing stride size (in bytes) along each of the
-                                                        ///< tensorRank - 1 dimensions.
+                                                        ///< TensorRank - 1 dimensions.
     const uint32_t *BoxDim,                             ///< [in] Array containing traversal box size (number of elments) along
-                                                        ///< each of the tensorRank dimensions. Specifies how many elements to be
+                                                        ///< each of the TensorRank dimensions. Specifies how many elements to be
                                                         ///< traversed along each tensor dimension.
-    const uint32_t *ElementStrides,                     ///< [in] Array containing traversal stride in each of the tensorRank
+    const uint32_t *ElementStrides,                     ///< [in] Array containing traversal stride in each of the TensorRank
                                                         ///< dimensions.
     ur_exp_tensor_map_interleave_flags_t Interleave,    ///< [in] Type of interleaved layout the tensor addresses
     ur_exp_tensor_map_swizzle_flags_t Swizzle,          ///< [in] Bank swizzling pattern inside shared memory
     ur_exp_tensor_map_l2_promotion_flags_t L2Promotion, ///< [in] L2 promotion size.
-    ur_exp_tensor_map_oob_fill_flags_t OobFill,         ///< [in] Indicate whether zero or special NaN constant will be used to
-                                                        ///< fill out-of-bound elements.
+    ur_exp_tensor_map_oob_fill_flags_t OobFill,         ///< [in] Indicates whether zero or special NaN constant will be used to
+                                                        ///< fill out-of-bounds elements.
     ur_exp_tensor_map_handle_t *hTensorMap              ///< [out] Handle of the tensor map object.
 );
 

scripts/core/exp-tensor-map.yml

@@ -9,7 +9,7 @@
 #
 --- #--------------------------------------------------------------------------
 type: header
-desc: "Intel $OneApi Unified Runtime Experimental API for enqueuing work through native APIs"
+desc: "Intel $OneApi Unified Runtime Experimental API for mapping tensor objects"
 ordinal: "100"
 
 --- #--------------------------------------------------------------------------
@@ -125,7 +125,7 @@ params:
       desc: "[in] Array containing tensor size (number of elements) along each of the TensorRank dimensions."
     - type: const uint64_t*
       name: GlobalStrides
-      desc: "[in] Array containing stride size (in bytes) along each of the tensorRank - 1 dimensions."
+      desc: "[in] Array containing stride size (in bytes) along each of the TensorRank - 1 dimensions."
     - type: const int*
       name: PixelBoxLowerCorner
       desc: "[in] Array containing DHW dimensions of lower box corner."
@@ -140,7 +140,7 @@ params:
       desc: "[in] Number of pixels per column."
     - type: const uint32_t*
       name: ElementStrides
-      desc: "[in] Array containing traversal stride in each of the tensorRank dimensions."
+      desc: "[in] Array containing traversal stride in each of the TensorRank dimensions."
     - type: $x_exp_tensor_map_interleave_flags_t
       name: Interleave
       desc: "[in] Type of interleaved layout the tensor addresses"
@@ -152,10 +152,13 @@ params:
       desc: "[in] L2 promotion size."
     - type: $x_exp_tensor_map_oob_fill_flags_t
       name: OobFill
-      desc: "[in] Indicate whether zero or special NaN constant will be used to fill out-of-bound elements."
+      desc: "[in] Indicates whether zero or special NaN constant will be used to fill out-of-bounds elements."
     - type: $x_exp_tensor_map_handle_t*
       name: hTensorMap
       desc: "[out] Handle of the tensor map object."
+returns:
+    - $X_RESULT_ERROR_INVALID_ARGUMENT:
+        - "`TensorRank < 3`"
 
 --- #--------------------------------------------------------------------------
 type: function
@@ -182,13 +185,13 @@ params:
       desc: "[in] Array containing tensor size (number of elements) along each of the TensorRank dimensions."
     - type: const uint64_t*
       name: GlobalStrides
-      desc: "[in] Array containing stride size (in bytes) along each of the tensorRank - 1 dimensions."
+      desc: "[in] Array containing stride size (in bytes) along each of the TensorRank - 1 dimensions."
     - type: const uint32_t*
       name: BoxDim
-      desc: "[in] Array containing traversal box size (number of elments) along each of the tensorRank dimensions. Specifies how many elements to be traversed along each tensor dimension."
+      desc: "[in] Array containing traversal box size (number of elments) along each of the TensorRank dimensions. Specifies how many elements to be traversed along each tensor dimension."
     - type: const uint32_t*
       name: ElementStrides
-      desc: "[in] Array containing traversal stride in each of the tensorRank dimensions."
+      desc: "[in] Array containing traversal stride in each of the TensorRank dimensions."
     - type: $x_exp_tensor_map_interleave_flags_t
       name: Interleave
       desc: "[in] Type of interleaved layout the tensor addresses"
@@ -200,8 +203,11 @@ params:
       desc: "[in] L2 promotion size."
     - type: $x_exp_tensor_map_oob_fill_flags_t
       name: OobFill
-      desc: "[in] Indicate whether zero or special NaN constant will be used to fill out-of-bound elements."
+      desc: "[in] Indicates whether zero or special NaN constant will be used to fill out-of-bounds elements."
     - type: $x_exp_tensor_map_handle_t*
       name: hTensorMap
       desc: "[out] Handle of the tensor map object."
+returns:
+    - $X_RESULT_ERROR_INVALID_ARGUMENT:
+        - "`TensorRank < 3`"
 

source/adapters/cuda/tensor_map.cpp

@@ -18,8 +18,8 @@ struct ur_exp_tensor_map_handle_t_ {
 };
 
 #define CONVERT(URTYPE, CUTYPE)                                                \
-  if (URTYPE & UrType)                                                         \
-    return CUTYPE;
+  if ((URTYPE)&UrType)                                                         \
+    return (CUTYPE);
 
 inline CUtensorMapDataType
 convertUrToCuDataType(ur_exp_tensor_map_data_type_flags_t UrType) {
@@ -71,7 +71,7 @@ convertUrToCuSwizzle(ur_exp_tensor_map_swizzle_flags_t UrType) {
 }
 
 CUtensorMapL2promotion
-convertUrToL2promotion(ur_exp_tensor_map_l2_promotion_flags_t UrType) {
+convertUrToCuL2Promotion(ur_exp_tensor_map_l2_promotion_flags_t UrType) {
   CONVERT(UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_NONE,
           CU_TENSOR_MAP_L2_PROMOTION_NONE);
   CONVERT(UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_64B,
@@ -84,7 +84,7 @@ convertUrToL2promotion(ur_exp_tensor_map_l2_promotion_flags_t UrType) {
 }
 
 CUtensorMapFloatOOBfill
-convertUrToCuOOBfill(ur_exp_tensor_map_oob_fill_flags_t UrType) {
+convertUrToCuOobFill(ur_exp_tensor_map_oob_fill_flags_t UrType) {
   CONVERT(UR_EXP_TENSOR_MAP_OOB_FILL_FLAG_NONE,
           CU_TENSOR_MAP_FLOAT_OOB_FILL_NONE);
   CONVERT(UR_EXP_TENSOR_MAP_OOB_FILL_FLAG_REQUEST_ZERO_FMA,
@@ -111,7 +111,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urTensorMapEncodeIm2ColExp(
         GlobalAddress, GlobalDim, GlobalStrides, PixelBoxLowerCorner,
         PixelBoxUpperCorner, ChannelsPerPixel, PixelsPerColumn, ElementStrides,
         convertUrToCuInterleave(Interleave), convertUrToCuSwizzle(Swizzle),
-        convertUrToL2promotion(L2Promotion), convertUrToCuOOBfill(OobFill)));
+        convertUrToCuL2Promotion(L2Promotion), convertUrToCuOobFill(OobFill)));
   } catch (ur_result_t Err) {
     return Err;
   }
@@ -134,7 +134,7 @@ UR_APIEXPORT ur_result_t UR_APICALL urTensorMapEncodeTiledExp(
         &(*hTensorMap)->Map, convertUrToCuDataType(TensorMapType), TensorRank,
         GlobalAddress, GlobalDim, GlobalStrides, BoxDim, ElementStrides,
         convertUrToCuInterleave(Interleave), convertUrToCuSwizzle(Swizzle),
-        convertUrToL2promotion(L2Promotion), convertUrToCuOOBfill(OobFill)));
+        convertUrToCuL2Promotion(L2Promotion), convertUrToCuOobFill(OobFill)));
   } catch (ur_result_t Err) {
     return Err;
   }

source/adapters/null/ur_nullddi.cpp

@@ -5919,15 +5919,15 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeIm2ColExp(
                    ///< the TensorRank dimensions.
     const uint64_t *
         GlobalStrides, ///< [in] Array containing stride size (in bytes) along each of the
-                       ///< tensorRank - 1 dimensions.
+                       ///< TensorRank - 1 dimensions.
     const int *
         PixelBoxLowerCorner, ///< [in] Array containing DHW dimensions of lower box corner.
     const int *
         PixelBoxUpperCorner, ///< [in] Array containing DHW dimensions of upper box corner.
     uint32_t ChannelsPerPixel, ///< [in] Number of channels per pixel.
     uint32_t PixelsPerColumn,  ///< [in] Number of pixels per column.
     const uint32_t *
-        ElementStrides, ///< [in] Array containing traversal stride in each of the tensorRank
+        ElementStrides, ///< [in] Array containing traversal stride in each of the TensorRank
                         ///< dimensions.
     ur_exp_tensor_map_interleave_flags_t
         Interleave, ///< [in] Type of interleaved layout the tensor addresses
@@ -5936,8 +5936,8 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeIm2ColExp(
     ur_exp_tensor_map_l2_promotion_flags_t
         L2Promotion, ///< [in] L2 promotion size.
     ur_exp_tensor_map_oob_fill_flags_t
-        OobFill, ///< [in] Indicate whether zero or special NaN constant will be used to
-                 ///< fill out-of-bound elements.
+        OobFill, ///< [in] Indicates whether zero or special NaN constant will be used to
+                 ///< fill out-of-bounds elements.
     ur_exp_tensor_map_handle_t
         *hTensorMap ///< [out] Handle of the tensor map object.
     ) try {
@@ -5977,13 +5977,13 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeTiledExp(
                    ///< the TensorRank dimensions.
     const uint64_t *
         GlobalStrides, ///< [in] Array containing stride size (in bytes) along each of the
-                       ///< tensorRank - 1 dimensions.
+                       ///< TensorRank - 1 dimensions.
     const uint32_t *
         BoxDim, ///< [in] Array containing traversal box size (number of elments) along
-    ///< each of the tensorRank dimensions. Specifies how many elements to be
+    ///< each of the TensorRank dimensions. Specifies how many elements to be
     ///< traversed along each tensor dimension.
     const uint32_t *
-        ElementStrides, ///< [in] Array containing traversal stride in each of the tensorRank
+        ElementStrides, ///< [in] Array containing traversal stride in each of the TensorRank
                         ///< dimensions.
     ur_exp_tensor_map_interleave_flags_t
         Interleave, ///< [in] Type of interleaved layout the tensor addresses
@@ -5992,8 +5992,8 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeTiledExp(
     ur_exp_tensor_map_l2_promotion_flags_t
         L2Promotion, ///< [in] L2 promotion size.
     ur_exp_tensor_map_oob_fill_flags_t
-        OobFill, ///< [in] Indicate whether zero or special NaN constant will be used to
-                 ///< fill out-of-bound elements.
+        OobFill, ///< [in] Indicates whether zero or special NaN constant will be used to
+                 ///< fill out-of-bounds elements.
     ur_exp_tensor_map_handle_t
         *hTensorMap ///< [out] Handle of the tensor map object.
     ) try {

source/loader/layers/tracing/ur_trcddi.cpp

@@ -7921,15 +7921,15 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeIm2ColExp(
                    ///< the TensorRank dimensions.
     const uint64_t *
         GlobalStrides, ///< [in] Array containing stride size (in bytes) along each of the
-                       ///< tensorRank - 1 dimensions.
+                       ///< TensorRank - 1 dimensions.
     const int *
         PixelBoxLowerCorner, ///< [in] Array containing DHW dimensions of lower box corner.
     const int *
         PixelBoxUpperCorner, ///< [in] Array containing DHW dimensions of upper box corner.
     uint32_t ChannelsPerPixel, ///< [in] Number of channels per pixel.
     uint32_t PixelsPerColumn,  ///< [in] Number of pixels per column.
     const uint32_t *
-        ElementStrides, ///< [in] Array containing traversal stride in each of the tensorRank
+        ElementStrides, ///< [in] Array containing traversal stride in each of the TensorRank
                         ///< dimensions.
     ur_exp_tensor_map_interleave_flags_t
         Interleave, ///< [in] Type of interleaved layout the tensor addresses
@@ -7938,8 +7938,8 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeIm2ColExp(
     ur_exp_tensor_map_l2_promotion_flags_t
         L2Promotion, ///< [in] L2 promotion size.
     ur_exp_tensor_map_oob_fill_flags_t
-        OobFill, ///< [in] Indicate whether zero or special NaN constant will be used to
-                 ///< fill out-of-bound elements.
+        OobFill, ///< [in] Indicates whether zero or special NaN constant will be used to
+                 ///< fill out-of-bounds elements.
     ur_exp_tensor_map_handle_t
         *hTensorMap ///< [out] Handle of the tensor map object.
 ) {
@@ -8004,13 +8004,13 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeTiledExp(
                    ///< the TensorRank dimensions.
     const uint64_t *
         GlobalStrides, ///< [in] Array containing stride size (in bytes) along each of the
-                       ///< tensorRank - 1 dimensions.
+                       ///< TensorRank - 1 dimensions.
     const uint32_t *
         BoxDim, ///< [in] Array containing traversal box size (number of elments) along
-    ///< each of the tensorRank dimensions. Specifies how many elements to be
+    ///< each of the TensorRank dimensions. Specifies how many elements to be
     ///< traversed along each tensor dimension.
     const uint32_t *
-        ElementStrides, ///< [in] Array containing traversal stride in each of the tensorRank
+        ElementStrides, ///< [in] Array containing traversal stride in each of the TensorRank
                         ///< dimensions.
     ur_exp_tensor_map_interleave_flags_t
         Interleave, ///< [in] Type of interleaved layout the tensor addresses
@@ -8019,8 +8019,8 @@ __urdlllocal ur_result_t UR_APICALL urTensorMapEncodeTiledExp(
     ur_exp_tensor_map_l2_promotion_flags_t
         L2Promotion, ///< [in] L2 promotion size.
     ur_exp_tensor_map_oob_fill_flags_t
-        OobFill, ///< [in] Indicate whether zero or special NaN constant will be used to
-                 ///< fill out-of-bound elements.
+        OobFill, ///< [in] Indicates whether zero or special NaN constant will be used to
+                 ///< fill out-of-bounds elements.
     ur_exp_tensor_map_handle_t
         *hTensorMap ///< [out] Handle of the tensor map object.
 ) {