doc: fixed formatting for primitive examples

oneapi-src · Dec 20, 2021 · b73c8a7 · b73c8a7
1 parent 42b9904
commit b73c8a7
Show file tree

Hide file tree

Showing 19 changed files with 24 additions and 50 deletions.
diff --git a/doc/primitives/batch_normalization.md b/doc/primitives/batch_normalization.md
@@ -245,9 +245,8 @@ directly.
 
 2. Use in-place operations whenever possible (see caveats in General Notes).
 
-## Example
+## Examples
 
-[**Batch Normalization Primitive Example**](@ref batch_normalization_example_cpp)
-Engine: CPU/GPU
+[Batch Normalization Primitive Example](@ref batch_normalization_example_cpp)
 
 @copydetails batch_normalization_example_cpp_short
diff --git a/doc/primitives/binary.md b/doc/primitives/binary.md
@@ -111,13 +111,10 @@ meaning associated with any of tensors dimensions.
 
 ## Examples
 
-[**Binary Primitive Example**](@ref binary_example_cpp)
-Engine: CPU/GPU
+[Binary Primitive Example](@ref binary_example_cpp)
 
 @copydetails binary_example_cpp_short
 
-
-[**Bnorm u8 by Binary Post-Ops Example**](@ref bnorm_u8_via_binary_postops_cpp)
-Engine: CPU/GPU 
+[Bnorm u8 by Binary Post-Ops Example](@ref bnorm_u8_via_binary_postops_cpp) 
 
 @copydetails bnorm_u8_via_binary_postops_cpp_short
diff --git a/doc/primitives/concat.md b/doc/primitives/concat.md
@@ -90,7 +90,6 @@ The concat primitive does not support any post-ops or attributes.
 
 ## Example
 
-[**Concat Primitive Example**](@ref concat_example_cpp)
-Engine: CPU/GPU 
+[Concat Primitive Example](@ref concat_example_cpp)
 
 @copydetails concat_example_cpp_short
diff --git a/doc/primitives/convolution.md b/doc/primitives/convolution.md
@@ -470,7 +470,6 @@ the convolution.)
 
 ## Example
 
-[**Convolution Primitive Example**](@ref convolution_example_cpp)
-Engine: CPU/GPU
+[Convolution Primitive Example](@ref convolution_example_cpp)
 
 @copydetails convolution_example_cpp_short
diff --git a/doc/primitives/eltwise.md b/doc/primitives/eltwise.md
@@ -176,7 +176,6 @@ meaning associated with any logical dimensions.
 
 ## Example
 
-[**Element-Wise Primitive Example**](@ref eltwise_example_cpp)
-Engine: CPU/GPU 
+[Eltwise Primitive Example](@ref eltwise_example_cpp)
 
 @copydetails eltwise_example_cpp_short
diff --git a/doc/primitives/inner_product.md b/doc/primitives/inner_product.md
@@ -152,7 +152,6 @@ object with argument `DNNL_ARG_ATTR_OUTPUT_SCALES` during the execution stage.
 
 ## Example
 
-[**Inner Product Primitive Example**](@ref inner_product_example_cpp) 
-Engine: CPU/GPU
+[Inner Product Primitive Example](@ref inner_product_example_cpp) 
 
 @copydetails inner_product_example_cpp_short
diff --git a/doc/primitives/layer_normalization.md b/doc/primitives/layer_normalization.md
@@ -201,7 +201,6 @@ The layer normalization primitive is optimized for the following memory formats:
 
 ## Example
 
-[**Layer Normalization Primitive Example**](@ref layer_normalization_example_cpp)
-Engine: CPU/GPU 
-
+[Layer Normalization Primitive Example](@ref layer_normalization_example_cpp)
+
 @copydetails layer_normalization_example_cpp_short
diff --git a/doc/primitives/logsoftmax.md b/doc/primitives/logsoftmax.md
@@ -135,8 +135,6 @@ typically referred to as channels (hence in formulas we use \f$c\f$).
 
 ## Example
 
-[**Logsoftmax Primitive Example**](@ref logsoftmax_example_cpp)
-Engine: CPU/GPU 
+[Logsoftmax Primitive Example](@ref logsoftmax_example_cpp)
 
 @copydetails logsoftmax_example_cpp_short
-
diff --git a/doc/primitives/lrn.md b/doc/primitives/lrn.md
@@ -140,7 +140,6 @@ The LRN primitive does not support any post-ops or attributes.
 
 ## Example
 
-[**Local Response Normalization Primitive Example**](@ref lrn_example_cpp)
-Engine: CPU/GPU 
+[LRN Primitive Example](@ref lrn_example_cpp)
 
 @copydetails lrn_example_cpp_short
diff --git a/doc/primitives/matmul.md b/doc/primitives/matmul.md
@@ -189,25 +189,21 @@ The following examples are available:
 
 ### Matrix Multiplication Primitive Examples
 
-[**MatMul Primitive Example**](@ref matmul_example_cpp)
-Engine: CPU/GPU
+[MatMul Primitive Example](@ref matmul_example_cpp)
 
 @copydetails matmul_example_cpp_short
 
 
-[**MatMul Tutorial: Comparison with SGEMM**](@ref cpu_sgemm_and_matmul_cpp)
-Engine: CPU
+[MatMul Tutorial: Comparison with SGEMM](@ref cpu_sgemm_and_matmul_cpp) (CPU only)
 
 @copydetails cpu_sgemm_and_matmul_cpp_short
 
 
-[**MatMul Tutorial: INT8 Inference**](@ref inference_int8_matmul_cpp) | 
-Engine: CPU/GPU
+[MatMul Tutorial: INT8 Inference](@ref inference_int8_matmul_cpp)
 
 @copydetails inference_int8_matmul_cpp_short
 
 
-[**MatMul Tutorial: Quantization**](@ref cpu_matmul_quantization_cpp)
-Engine: CPU
+[MatMul Tutorial: Quantization](@ref cpu_matmul_quantization_cpp) (CPU only)
 
 @copydetails cpu_matmul_quantization_cpp_short
diff --git a/doc/primitives/pooling.md b/doc/primitives/pooling.md
@@ -161,7 +161,6 @@ N/A
 
 ## Example
 
-[**Pooling Primitive Example**](@ref pooling_example_cpp)
-Engine: CPU/GPU 
+[Pooling Primitive Example](@ref pooling_example_cpp)
 
 @copydetails pooling_example_cpp_short
diff --git a/doc/primitives/prelu.md b/doc/primitives/prelu.md
@@ -132,7 +132,6 @@ data memory format.
 
 ## Example
 
-[**PReLU Primitive Example**](@ref prelu_example_cpp)
-Engine: CPU/GPU 
+[PReLU Primitive Example](@ref prelu_example_cpp)
 
 @copydetails prelu_example_cpp_short
diff --git a/doc/primitives/reduction.md b/doc/primitives/reduction.md
@@ -103,7 +103,6 @@ meaning associated with any of the dimensions of a tensor.
 
 ## Example
 
-[**Reduction Primitive Example**](@ref reduction_example_cpp)
-Engine: CPU/GPU
+[Reduction Primitive Example](@ref reduction_example_cpp)
 
 @copydetails reduction_example_cpp_short
diff --git a/doc/primitives/reorder.md b/doc/primitives/reorder.md
@@ -124,7 +124,6 @@ N/A
 
 ## Example
 
-[**Reorder Primitive Example**](@ref reorder_example_cpp)
-Engine: CPU/GPU 
+[Reorder Primitive Example](@ref reorder_example_cpp)
 
 @copydetails reorder_example_cpp_short
diff --git a/doc/primitives/resampling.md b/doc/primitives/resampling.md
@@ -150,7 +150,6 @@ N/A
 
 ## Example
 
-[**Resampling Primitive Example**](@ref resampling_example_cpp)
-Engine: CPU/GPU 
+[Resampling Primitive Example](@ref resampling_example_cpp)
 
 @copydetails resampling_example_cpp_short
diff --git a/doc/primitives/rnn.md b/doc/primitives/rnn.md
@@ -404,7 +404,6 @@ details on how to use and set these quantization parameters.
 
 ## Example
 
-[**LSTM RNN Primitive Example**](@ref lstm_example_cpp)
-Engine: CPU/GPU
+[LSTM RNN Primitive Example](@ref lstm_example_cpp)
 
 @copydetails lstm_example_cpp_short
diff --git a/doc/primitives/shuffle.md b/doc/primitives/shuffle.md
@@ -124,7 +124,6 @@ N/A
 
 ## Example
 
-[**Shuffle Primitive Example**](@ref shuffle_example_cpp)
-Engine: CPU/GPU 
+[Shuffle Primitive Example](@ref shuffle_example_cpp)
 
 @copydetails shuffle_example_cpp_short
diff --git a/doc/primitives/softmax.md b/doc/primitives/softmax.md
@@ -123,7 +123,6 @@ typically referred to as channels (hence in formulas we use \f$c\f$).
 
 ## Example
 
-[**Softmax Primitive Example**](@ref softmax_example_cpp)
-Engine: CPU/GPU 
+[Softmax Primitive Example](@ref softmax_example_cpp)
 
 @copydetails softmax_example_cpp_short
diff --git a/doc/primitives/sum.md b/doc/primitives/sum.md
@@ -86,7 +86,5 @@ meaning associated with any logical dimensions.
 ## Example
 
 [**Sum Primitive Example**](@ref sum_example_cpp)
-Engine: CPU/GPU 
 
 @copydetails sum_example_cpp_short
-