diff --git a/doc/fluid/api_guides/low_level/layers/sequence.rst b/doc/fluid/api_guides/sequence.rst similarity index 73% rename from doc/fluid/api_guides/low_level/layers/sequence.rst rename to doc/fluid/api_guides/sequence.rst index 8f1d0ea51985a33dc1604d9030c012502d78b0a7..41da8fc733f0ed95a6c51a149f09b9b0032458a2 100644 --- a/doc/fluid/api_guides/low_level/layers/sequence.rst +++ b/doc/fluid/api_guides/sequence.rst @@ -22,9 +22,7 @@ 这个layer以一个mini batch的序列为输入，在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列，只不过在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 -API Reference 请参考 api_fluid_layers_sequence_softmax_ - -.. _api_fluid_layers_sequence_softmax: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-softmax +API Reference 请参考 :ref:`api_fluid_layers_sequence_softmax` 2. sequence_concat @@ -33,27 +31,21 @@ API Reference 请参考 api_fluid_layers_sequence_softmax_ 该layer会将每个batch中的第i个序列在时间步的那一维拼接成一个新的序列，作为返回的batch中的第i个序列。 理所当然地，list中每个LoDTensor的序列必须有相同的batch size. -API Reference 请参考 api_fluid_layers_sequence_concat_ - -.. _api_fluid_layers_sequence_concat: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-concat +API Reference 请参考 :ref:`api_fluid_layers_sequence_concat` 3. sequence_first_step ---------------------- 这个layer以一个LoDTensor作为输入，会取出每个序列中的第一个元素（也就是时间步的第一步的元素），并作为返回值。 -API Reference 请参考 api_fluid_layers_sequence_first_step_ - -.. _api_fluid_layers_sequence_first_step: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-first-step +API Reference 请参考 :ref:`api_fluid_layers_sequence_first_step` 4. sequence_last_step --------------------- 同 :code:`sequence_first_step` ，不过是取每个序列中最后一个元素（时间步的最后一步）作为返回值。 -API Reference 请参考 api_fluid_layers_sequence_last_step_ - -.. _api_fluid_layers_sequence_last_step: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-last-step +API Reference 请参考 :ref:`api_fluid_layers_sequence_last_step` 5. sequence_expand @@ -61,9 +53,7 @@ API Reference 请参考 api_fluid_layers_sequence_last_step_ 这个layer有两个LoDTensor的序列作为输入，并按照第二个LoDTensor中序列的LoD信息来扩展第一个batch中的序列。 通常用来将只有一个时间步的序列（例如 :code:`sequence_first_step` 的返回结果）延展成有多个时间步的序列，以此方便进行对位运算。 -API Reference 请参考 api_fluid_layers_sequence_expand_ - -.. _api_fluid_layers_sequence_expand: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-expand +API Reference 请参考 :ref:`api_fluid_layers_sequence_expand` 6. sequence_expand_as @@ -71,18 +61,14 @@ API Reference 请参考 api_fluid_layers_sequence_expand_ 这个layer需要两个LoDTensor的序列作为输入，然后将第一个Tensor序列中的每一个序列延展成和第二个Tensor中对应序列等长的序列。 如果无法延展成等长的（例如第二个batch中的序列长度不是第一个batch中序列长度的整数倍），则会报错。 -API Reference 请参考 api_fluid_layers_sequence_expand_as_ - -.. _api_fluid_layers_sequence_expand_as: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-expand-as +API Reference 请参考 :ref:`api_fluid_layers_sequence_expand_as` 7. sequence_enumerate --------------------- 这个layer需要一个LoDTensor的序列作为输入，同时需要指定一个 :code:`win_size` 的长度。这个layer将依次取所有序列中长度为 :code:`win_size` 的子序列，并组合成新的序列。 -API Reference 请参考 api_fluid_layers_sequence_enumerate_ - -.. _api_fluid_layers_sequence_enumerate: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-enumerate +API Reference 请参考 :ref:`api_fluid_layers_sequence_enumerate` 8. sequence_reshape @@ -90,9 +76,7 @@ API Reference 请参考 api_fluid_layers_sequence_enumerate_ 这个layer需要一个LoDTensor的序列作为输入，同时需要指定一个 :code:`new_dim` 作为新的序列的维度。 该layer会将mini batch内每个序列reshape为new_dim给定的维度。注意，每个序列的长度会改变（因此LoD信息也会变），以适应新的形状。 -API Reference 请参考 api_fluid_layers_sequence_reshape_ - -.. _api_fluid_layers_sequence_reshape: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-reshape +API Reference 请参考 :ref:`api_fluid_layers_sequence_reshape` 9. sequence_scatter @@ -100,9 +84,7 @@ API Reference 请参考 api_fluid_layers_sequence_reshape_ 这个layer可以将一个序列的数据scatter到另一个tensor上。这个layer有三个input，一个要被scatter的目标tensor :code:`input`； 一个是序列的数据 :code:`update` ，一个是目标tensor的上坐标 :code:`index` . Output为scatter后的tensor，形状和 :code:`input` 相同。 -API Reference 请参考 api_fluid_layers_sequence_scatter_ - -.. _api_fluid_layers_sequence_scatter: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-scatter +API Reference 请参考 :ref:`api_fluid_layers_sequence_scatter` 10. sequence_pad @@ -111,9 +93,7 @@ API Reference 请参考 api_fluid_layers_sequence_scatter_ 前者是用来补齐序列的元素，可以是一个数也可以是一个tensor；后者是序列补齐的目标长度。 这个layer会返回补齐后的序列，以及一个记录补齐前各个序列长度的tensor :code:`Length` . -API Reference 请参考 api_fluid_layers_sequence_pad_ - -.. _api_fluid_layers_sequence_pad: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-pad +API Reference 请参考 :ref:`api_fluid_layers_sequence_pad` 11. sequence_mask @@ -123,7 +103,5 @@ API Reference 请参考 api_fluid_layers_sequence_pad_ 通常这个layer用于生成一个mask，将被pad后的序列中pad的部分过滤掉。 :code:`input` 的长度tensor通常可以直接用 :code:`sequence_pad` 返回的 :code:`Length` . -API Reference 请参考 api_fluid_layers_sequence_mask_ - -.. _api_fluid_layers_sequence_mask: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-mask +API Reference 请参考 :ref:`api_fluid_layers_sequence_mask`