Concat

API Reference

General

The concat primitive concatenates \(N\) tensors over concat_dimension (here designated \(C\)) and is defined as (the variable names follow the standard Naming Conventions):

\[\dst(\overline{ou}, c, \overline{in}) = \src_i(\overline{ou}, c', \overline{in}),\]

where \(c = C_1 + .. + C_{i-1} {}_{} + c'\).

The concat primitive does not have a notion of forward or backward propagation. The backward propagation for the concatenation operation is simply an identity operation.

Execution Arguments

When executed, the inputs and outputs should be mapped to an execution argument index as specified by the following table.

Primitive input/output

Execution argument index

\(\src\)

DNNL_ARG_MULTIPLE_SRC

\(\dst\)

DNNL_ARG_DST

Implementation Details

General Notes

  1. The \(\dst\) memory format can be either specified by a user or derived by the primitive. The recommended way is to allow the primitive to choose the most appropriate format.

  2. The concat primitive requires all source and destination tensors to have the same shape except for the concat_dimension. The destination dimension for the concat_dimension must be equal to the sum of the concat_dimension dimensions of the sources (i.e. \(C = \sum_i C_i\)). Implicit broadcasting is not supported.

Data Types Support

The concat primitive supports arbitrary data types for source and destination tensors according to the Data Types page. However, it is required that all source tensors are of the same data type (but not necessarily matching the data type of the destination tensor).

Data Representation

The concat primitive works with arbitrary data tensors. There is no special meaning associated with any logical dimensions.

Post-ops and Attributes

The concat primitive does not support any post-ops or attributes.

Implementation Limitations

  1. The primitive works with several memory formats, such as plain formats dnnl_nchw, dnnl_nhwc, and blocked formats dnnl_nChw16c, dnnl_nCdhw8c that appear in convolutions. The primitive does not support non-blocked formats that are typically used in prepacked weights, such as:

  2. Refer to Data Types for limitations related to data types support.

Performance Tips

  1. Whenever possible, avoid specifying the destination memory format so that the primitive is able to choose the most appropriate one.

  2. The concat primitive is highly optimized for the cases in which all source tensors have same memory format and data type matches the destination tensor data type. For other cases, more general but slower code is working. Consider reordering sources to the same data format before using the concat primitive.

Examples

Engine

Name

Comments

CPU/GPU

Concat Primitive Example

This C++ API example demonstrates how to create and execute a Concat primitive.

Key optimizations included in this example: