Scan¶

Scan - 23¶

版本¶

名称: Scan (GitHub)
域: main
自版本: 23
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的算子自版本 23起可用。

摘要¶

Scan 可用于迭代一个或多个 scan_input 张量，构造零个或多个 scan_output 张量。它结合了通用递归、函数式编程结构（如 scan、fold、map 和 zip）的想法，旨在启用类似 RNN 的结构的泛化，以进行序列到序列的处理。其他张量（此处称为 state_variables）可用于在从一个元素迭代到另一个元素时携带状态（类似于 RNN 中的隐藏状态，在循环上下文中也称为循环携带依赖项）。许多常见用法涉及单个 scan_input 张量（其中可以获得类似于 scan、fold 和 map 的功能）。当使用多个 scan_input 时，会获得类似于 zip 的行为。

属性 body 必须是一个图，指定每次迭代中要执行的计算。它以 state_variables 的当前值和 scan_inputs 的当前迭代元素作为输入。它必须返回 state_variables 的（更新的）值和零个或多个 scan_output_element 张量。scan_output_element 张量的值在所有迭代中连接起来，以生成 scan 结构的 scan_output 值（类似于类似 RNN 的结构的连接的中间隐藏状态值）。所有输出张量（state_variables 以及 scan_output_element 张量）都要求在循环的每次迭代中具有相同的形状（为了启用高效的内存分配而施加的限制）。

请注意，传递给主体子图的迭代元素没有序列轴。它的秩将比相应的 scan_input 的秩少一。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

可选属性 scan_input_directions 指定每个 scan 输入的方向（向前或向后）。如果省略此属性，则所有序列都将向前扫描。可以通过在 scan_inputs 中两次指定相同的张量输入来执行双向扫描，一次向前方向，一次向后方向。

操作的 scan_output 是通过在每次迭代中连接 body 生成的 scan_output_element 值而产生的。可选属性 scan_output_directions 指定构建 scan_output 的方向（在每次迭代中将 scan_output_element 附加到或前置到 scan_output）对于每个 scan_output。如果省略此属性，则在每次迭代中将 scan_output_element 附加到 scan_output。

可选属性 scan_input_axes 指定要为每个 scan_input 扫描的轴。如果省略，则每个 scan_input 都将在轴 0 上扫描。例如，如果轴 0 是批次轴，轴 1 是时间轴（要扫描），则指定轴值为 1。请注意，扫描非零轴可能效率低于扫描轴零。

可选属性 scan_output_axes 指定沿其累积 scan_outputs 的轴对于每个 scan_output。例如，如果轴 1 是输入和输出的时间轴（要扫描），则指定 scan_input 轴和 scan_output 轴值为 1。

请注意，由于 ONNX 的限制，即只有算子的最后一个参数可以是可变的，因此初始状态和 scan 输入一起列为一个输入参数。类似地，最终状态和 scan 输出一起列为一个输出参数。属性 num_scan_inputs 指示 scan 输入的数量 M。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body,
    scan_input_axes = [axis_1, ..., axis_m]
> (init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i
// scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j.
sequence_length = scan_1.shape[axis_1];

// initialize state-variables
st_1 = init_1; ... st_n = init_n;
// initialize scan-output variables: [] denotes an empty tensor
scan_out_1 = []; ...; scan_out_k = [];
// identify number of iterations:

// execute loop
for (int t = 0; t < sequence_length; ++t) {
    // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
    // of rank one less than T obtained by indexing T at position t along axis k.
    si_1 = scan_1<axis=axis_1>[t];
    ... ;
    si_m = scan_m<axis=axis_m>[t];
    // execute loop-body
    st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
    // accumulate the scan-output elements
    scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
}

return st_1, ..., st_n, scan_out_1, ..., scan_out_k;

示例用法：使用 Scan 编码 RNN

以下示例显示了如何对输入张量 %X、权重张量 %Wi、递归权重张量 %Ri、偏差张量 %Wbi 和 %Rbi 以及初始隐藏状态 %H_0 进行简单的 RNN 编码为 ScanLoop。请注意，循环体是一个嵌套图，它直接计算

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。
scan_input_axes - INTS
:

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 扫描的轴（序列轴）。如果省略，则将 0 用作每个 scan_input 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]，其中 r = rank(input)。
scan_input_directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
scan_output_axes - INTS :

一个可选的 K 个标志的列表。列表的第 i 个元素指定第 i 个 scan_output 的轴。扫描输出沿指定的轴累积。如果省略，则将 0 用作每个 scan_output 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]。
scan_output_directions - INTS :

一个可选的 K 个标志的列表，每个 scan_output 一个。列表的第 i 个元素指定在每次迭代中是否应通过追加或预先追加新值来构造第 i 个 scan_output：0 表示追加，1 表示预先追加。如果省略，则所有 scan_output 张量都将通过在每次迭代中追加一个值来生成。

输入¶

1 到 2147483647 个输入。

initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

V in ( tensor(bfloat16), tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(float4e2m1), tensor(float8e4m3fn), tensor(float8e4m3fnuz), tensor(float8e5m2), tensor(float8e5m2fnuz), tensor(int16), tensor(int32), tensor(int4), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint4), tensor(uint64), tensor(uint8) )

所有 Tensor 类型，最高到 IRv11。

Scan - 21 对比 23

Scan - 21¶

版本¶

名称: Scan (GitHub)
域: main
since_version: 21
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的运算符自版本 21 起可用。

摘要¶

请注意，传递给主体子图的迭代元素没有序列轴。它的秩将比相应的 scan_input 的秩少一。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body,
    scan_input_axes = [axis_1, ..., axis_m]
> (init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i
// scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j.
sequence_length = scan_1.shape[axis_1];

// initialize state-variables
st_1 = init_1; ... st_n = init_n;
// initialize scan-output variables: [] denotes an empty tensor
scan_out_1 = []; ...; scan_out_k = [];
// identify number of iterations:

// execute loop
for (int t = 0; t < sequence_length; ++t) {
    // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
    // of rank one less than T obtained by indexing T at position t along axis k.
    si_1 = scan_1<axis=axis_1>[t];
    ... ;
    si_m = scan_m<axis=axis_m>[t];
    // execute loop-body
    st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
    // accumulate the scan-output elements
    scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
}

return st_1, ..., st_n, scan_out_1, ..., scan_out_k;

示例用法：使用 Scan 编码 RNN

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。
scan_input_axes - INTS
:

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 扫描的轴（序列轴）。如果省略，则将 0 用作每个 scan_input 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]，其中 r = rank(input)。
scan_input_directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
scan_output_axes - INTS :

一个可选的 K 个标志的列表。列表的第 i 个元素指定第 i 个 scan_output 的轴。扫描输出沿指定的轴累积。如果省略，则将 0 用作每个 scan_output 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]。
scan_output_directions - INTS :

一个可选的 K 个标志的列表，每个 scan_output 一个。列表的第 i 个元素指定在每次迭代中是否应通过追加或预先追加新值来构造第 i 个 scan_output：0 表示追加，1 表示预先追加。如果省略，则所有 scan_output 张量都将通过在每次迭代中追加一个值来生成。

输入¶

1 到 2147483647 个输入。

initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

V in ( tensor(bfloat16), tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(float8e4m3fn), tensor(float8e4m3fnuz), tensor(float8e5m2), tensor(float8e5m2fnuz), tensor(int16), tensor(int32), tensor(int4), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint4), tensor(uint64), tensor(uint8) )

所有 Tensor 类型，最高到 IRv10。

Scan - 19¶

版本¶

名称: Scan (GitHub)
域: main
since_version: 19
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的运算符自版本 19 起可用。

摘要¶

请注意，传递给主体子图的迭代元素没有序列轴。它的秩将比相应的 scan_input 的秩少一。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body,
    scan_input_axes = [axis_1, ..., axis_m]
> (init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i
// scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j.
sequence_length = scan_1.shape[axis_1];

// initialize state-variables
st_1 = init_1; ... st_n = init_n;
// initialize scan-output variables: [] denotes an empty tensor
scan_out_1 = []; ...; scan_out_k = [];
// identify number of iterations:

// execute loop
for (int t = 0; t < sequence_length; ++t) {
    // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
    // of rank one less than T obtained by indexing T at position t along axis k.
    si_1 = scan_1<axis=axis_1>[t];
    ... ;
    si_m = scan_m<axis=axis_m>[t];
    // execute loop-body
    st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
    // accumulate the scan-output elements
    scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
}

return st_1, ..., st_n, scan_out_1, ..., scan_out_k;

示例用法：使用 Scan 编码 RNN

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。
scan_input_axes - INTS
:

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 扫描的轴（序列轴）。如果省略，则将 0 用作每个 scan_input 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]，其中 r = rank(input)。
scan_input_directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
scan_output_axes - INTS :

一个可选的 K 个标志的列表。列表的第 i 个元素指定第 i 个 scan_output 的轴。扫描输出沿指定的轴累积。如果省略，则将 0 用作每个 scan_output 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]。
scan_output_directions - INTS :

一个可选的 K 个标志的列表，每个 scan_output 一个。列表的第 i 个元素指定在每次迭代中是否应通过追加或预先追加新值来构造第 i 个 scan_output：0 表示追加，1 表示预先追加。如果省略，则所有 scan_output 张量都将通过在每次迭代中追加一个值来生成。

输入¶

1 到 2147483647 个输入。

initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

V in ( tensor(bfloat16), tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(float8e4m3fn), tensor(float8e4m3fnuz), tensor(float8e5m2), tensor(float8e5m2fnuz), tensor(int16), tensor(int32), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint64), tensor(uint8) )

所有 Tensor 类型，最高到 IRv9。

Scan - 16¶

版本¶

名称: Scan (GitHub)
域: main
since_version: 16
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的运算符自版本 16 起可用。

摘要¶

请注意，传递给主体子图的迭代元素没有序列轴。它的秩将比相应的 scan_input 的秩少一。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body,
    scan_input_axes = [axis_1, ..., axis_m]
> (init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i
// scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j.
sequence_length = scan_1.shape[axis_1];

// initialize state-variables
st_1 = init_1; ... st_n = init_n;
// initialize scan-output variables: [] denotes an empty tensor
scan_out_1 = []; ...; scan_out_k = [];
// identify number of iterations:

// execute loop
for (int t = 0; t < sequence_length; ++t) {
    // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
    // of rank one less than T obtained by indexing T at position t along axis k.
    si_1 = scan_1<axis=axis_1>[t];
    ... ;
    si_m = scan_m<axis=axis_m>[t];
    // execute loop-body
    st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
    // accumulate the scan-output elements
    scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
}

return st_1, ..., st_n, scan_out_1, ..., scan_out_k;

示例用法：使用 Scan 编码 RNN

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。
scan_input_axes - INTS
:

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 扫描的轴（序列轴）。如果省略，则将 0 用作每个 scan_input 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]，其中 r = rank(input)。
scan_input_directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
scan_output_axes - INTS :

一个可选的 K 个标志的列表。列表的第 i 个元素指定第 i 个 scan_output 的轴。扫描输出沿指定的轴累积。如果省略，则将 0 用作每个 scan_output 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]。
scan_output_directions - INTS :

一个可选的 K 个标志的列表，每个 scan_output 一个。列表的第 i 个元素指定在每次迭代中是否应通过追加或预先追加新值来构造第 i 个 scan_output：0 表示追加，1 表示预先追加。如果省略，则所有 scan_output 张量都将通过在每次迭代中追加一个值来生成。

输入¶

1 到 2147483647 个输入。

initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

V in ( tensor(bfloat16), tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(int16), tensor(int32), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint64), tensor(uint8) )

所有 Tensor 类型，最高到 IRv4。

Scan - 11¶

版本¶

名称: Scan (GitHub)
域: main
since_version: 11
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的运算符自版本 11 起可用。

摘要¶

请注意，传递给主体子图的迭代元素没有序列轴。它的秩将比相应的 scan_input 的秩少一。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body,
    scan_input_axes = [axis_1, ..., axis_m]
> (init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i
// scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j.
sequence_length = scan_1.shape[axis_1];

// initialize state-variables
st_1 = init_1; ... st_n = init_n;
// initialize scan-output variables: [] denotes an empty tensor
scan_out_1 = []; ...; scan_out_k = [];
// identify number of iterations:

// execute loop
for (int t = 0; t < sequence_length; ++t) {
    // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
    // of rank one less than T obtained by indexing T at position t along axis k.
    si_1 = scan_1<axis=axis_1>[t];
    ... ;
    si_m = scan_m<axis=axis_m>[t];
    // execute loop-body
    st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
    // accumulate the scan-output elements
    scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
}

return st_1, ..., st_n, scan_out_1, ..., scan_out_k;

示例用法：使用 Scan 编码 RNN

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。
scan_input_axes - INTS
:

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 扫描的轴（序列轴）。如果省略，则将 0 用作每个 scan_input 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]，其中 r = rank(input)。
scan_input_directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
scan_output_axes - INTS :

一个可选的 K 个标志的列表。列表的第 i 个元素指定第 i 个 scan_output 的轴。扫描输出沿指定的轴累积。如果省略，则将 0 用作每个 scan_output 的扫描轴。轴的负值表示从后向前计数维度。接受的范围是 [-r, r-1]。
scan_output_directions - INTS :

一个可选的 K 个标志的列表，每个 scan_output 一个。列表的第 i 个元素指定在每次迭代中是否应通过追加或预先追加新值来构造第 i 个 scan_output：0 表示追加，1 表示预先追加。如果省略，则所有 scan_output 张量都将通过在每次迭代中追加一个值来生成。

输入¶

1 到 2147483647 个输入。

initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

V in ( tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(int16), tensor(int32), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint64), tensor(uint8) )

所有 Tensor 类型

Scan - 9¶

版本¶

名称: Scan (GitHub)
域: main
since_version: 9
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的运算符自版本 9 起可用。

摘要¶

请注意，传递给主体子图的迭代元素没有序列轴。它的秩将比相应的 scan_input 的秩少一。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body,
    scan_input_axes = [axis_1, ..., axis_m]
> (init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i
// scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j.
sequence_length = scan_1.shape[axis_1];

// initialize state-variables
st_1 = init_1; ... st_n = init_n;
// initialize scan-output variables: [] denotes an empty tensor
scan_out_1 = []; ...; scan_out_k = [];
// identify number of iterations:

// execute loop
for (int t = 0; t < sequence_length; ++t) {
    // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
    // of rank one less than T obtained by indexing T at position t along axis k.
    si_1 = scan_1<axis=axis_1>[t];
    ... ;
    si_m = scan_m<axis=axis_m>[t];
    // execute loop-body
    st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
    // accumulate the scan-output elements
    scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
}

return st_1, ..., st_n, scan_out_1, ..., scan_out_k;

示例用法：使用 Scan 编码 RNN

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。
scan_input_axes - INTS
:

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 扫描的轴（序列轴）。如果省略，则 0 将用作每个 scan_input 的扫描轴。
scan_input_directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
scan_output_axes - INTS :

一个可选的 K 个标志的列表。列表的第 i 个元素指定第 i 个 scan_output 的轴。scan 输出沿着指定的轴累积。如果省略，则 0 将用作每个 scan_output 的扫描轴。
scan_output_directions - INTS :

一个可选的 K 个标志的列表，每个 scan_output 一个。列表的第 i 个元素指定在每次迭代中是否应通过追加或预先追加新值来构造第 i 个 scan_output：0 表示追加，1 表示预先追加。如果省略，则所有 scan_output 张量都将通过在每次迭代中追加一个值来生成。

输入¶

1 到 2147483647 个输入。

initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

V in ( tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(int16), tensor(int32), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint64), tensor(uint8) )

所有 Tensor 类型

Scan - 8¶

版本¶

名称: Scan (GitHub)
域: main
since_version: 8
函数: False
支持级别: SupportType.COMMON
形状推断: True

此版本的算子自版本 8起可用。

摘要¶

Scan 可用于迭代一个或多个 scan_input 张量，构建零个或多个 scan_output 张量。它结合了通用递归、函数式编程结构（如 scan、fold、map 和 zip）的想法，旨在实现 RNN 类结构的泛化，用于序列到序列处理。其他张量（此处称为 state_variables）可用于在从一个元素迭代到另一个元素时携带状态（类似于 RNN 中的隐藏状态，在循环上下文中也称为循环携带依赖项）。所有这些张量都要求在循环的每次迭代中具有相同的形状（为实现高效内存分配而施加的限制）。许多常见用法涉及单个 scan_input 张量（其中可以获得类似于 scan、fold 和 map 的功能）。当使用多个 scan_input 时，将获得类似于 zip 的行为。

属性 body 必须是一个图，指定每次迭代中要执行的计算。它以 state_variables 的当前值和 scan_inputs 的当前迭代元素作为输入。它必须返回 state_variables 的（更新）值和零个或多个 scan_output_element 张量。scan_output_element 张量的值在所有迭代中连接起来，以产生 scan 结构的 scan_output 值（类似于 RNN 类结构的连接中间隐藏状态值）。

scan 操作返回 state_variables 的最终值以及 scan_outputs。

该操作支持批处理，并且批处理轴必须为 0。当使用多个 scan_input 张量时，它们都必须具有相同的批大小，并且都必须具有相同的最大序列长度（序列轴或扫描轴的维度）。序列轴或扫描轴必须为 1。

该操作有一个可选的 sequence_lens 输入（形状为 [BATCH_SIZE]），以允许长度 <= 最大序列长度的可变长度序列。如果未指定此输入，则所有序列都被假定为长度等于最大序列长度。对于可变长度输入序列，scan_outputs 将由与输入相同长度的序列组成，并填充到最大序列长度。

可选属性 directions 可用于反向扫描序列。如果省略此属性，则所有序列都将正向扫描。可以通过在 scan_inputs 中两次指定相同的张量输入来执行双向扫描，一次使用正向方向，一次使用反向方向。

的行为

Scan <
    num_scan_inputs = m,
    body = loop-body
> (sequence_lengths, init_1, ..., init_n, scan_1, ..., scan_m)

等效于以下伪代码

// T.shape[0] denotes the batch-size of T
// The batch-size of scan_1, ..., scan_m are all required to be equal
batch_size = scan_1.shape[0];

// scan_i.shape[1] denotes the (max) sequence-length of scan_i
// scan_i.shape[1] is required to be equal to scan_j.shape[1] for all i,j.
max_sequence_length = scan_1.shape[1];

for (int batch = 0; batch < batch_size; ++batch) {
    // initialize state-variables
    st_1 = init_1; ... st_n = init_n;
    // initialize scan-output variables: [] denotes an empty tensor
    scan_out_1 = []; ...; scan_out_k = [];
    // identify number of iterations:
    N = (sequence_lengths specified) ? sequence_lengths[batch] : max_sequence_length;

    // execute loop
    for (int t = 0; t < N; ++t) {
        // generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor
        // of rank one less than T obtained by indexing T at position t along axis k.
        si_1 = (scan_1<axis=0>[batch])<axis=1>[t];
        ... ;
        si_m = (scan_m<axis=0>[batch])<axis=1>[t];
        // execute loop-body
        st_1, ..., st_n, so_1, ..., so_k = loop-body(st_1, ..., st_n, si_1, ..., si_m)
        // accumulate the scan-output elements
        scan_out_1 = Concat<axis=0>(scan_out_1, so_1); ... ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);
    }
    // accumulate the outputs for this batch:
    bst_1[batch] = st_1; ..., bst_n[batch] = st_n;
    // Note scan-outputs will have size max_sequence_length, but only first N values will be meaningful.
    // The remaining values have an undefined value.
    b_scan_out_1[batch] = scan_out_1; ...; b_scan_out_k[batch] = scan_out_k;
}
return bst_1, ..., bst_n, b_scan_out_1, ..., b_scan_out_k;

示例用法：使用 Scan 编码 RNN

值是在外部图中计算的，它们需要作为额外的 state_variables 传入。

graph rnn-encoding {
  %H_0 = ...
  %X = ...
  %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1]("", %H_0, %X)
  return %Y, %Y_h
}

graph rnn-cell-1 (
  %H_tminus1[FLOAT, tensor]
  %X_t[FLOAT, tensor]
) {
  %Wi = ...
  %Ri = ...
  %Wbi = ...
  %Rbi = ...
  %t1 = X_t * (Wi^T)
  %t2 = H_tminus1*(Ri^T)
  %t3 = Add(%t1, %t2)
  %t4 = Add(%t3, %Wbi)
  %t5 = Add(%t4, %Rbi)
  %Ht = Tanh(%t5)
  %Accumulate = Identity(%Ht)
  return %Ht, %Accumulate
}

属性¶

body - GRAPH (必需)

每次迭代运行的图。它有 N+M 个输入：(循环状态变量…，scan_input_elts…)。它有 N+K 个输出：(循环状态变量…，scan_output_elts…)。每个 scan_output 通过在循环的每次迭代结束时连接指定 scan_output_elt 值的值来创建。如果这些值的维度在循环迭代中发生变化，则为错误。
directions - INTS :

一个可选的 M 个标志的列表。列表的第 i 个元素指定要为第 i 个 scan_input 张量扫描的方向：0 表示正向，1 表示反向。如果省略，则所有 scan_input 张量都将按正向扫描。
num_scan_inputs - INT (必需)

指定 scan_inputs 数量 M 的属性。

输入¶

2 到 2147483647 个输入。

sequence_lens（可选，异构） - I

可选张量，指定批次中序列的长度。如果未指定此输入，则所有序列都被假定为最大序列长度（scan_input 张量的序列轴的维度）。
initial_state_and_scan_inputs (可变参数) - V

循环的 N 个状态变量的初始值，后跟 M 个 scan_input

输出¶

1 到 2147483647 个输出。

final_state_and_scan_outputs (可变参数) - V

循环的 N 个状态变量的最终值，后跟 K 个 scan_output

类型约束¶

I in ( tensor(int64) )

Int64 张量
V in ( tensor(bool), tensor(complex128), tensor(complex64), tensor(double), tensor(float), tensor(float16), tensor(int16), tensor(int32), tensor(int64), tensor(int8), tensor(string), tensor(uint16), tensor(uint32), tensor(uint64), tensor(uint8) )

所有 Tensor 类型