[Docathon][Add API Legend No.18]为roll API 添加插图 (PaddlePaddle#6810)

* Modify the roll API documentation * fix document * update * update and fix roll_cn.rst
Aoraki-Dream · Sep 4, 2024 · 0f1efa3 · 0f1efa3
1 parent 2c16d84
commit 0f1efa3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/api/paddle/roll_cn.rst b/docs/api/paddle/roll_cn.rst
@@ -18,7 +18,18 @@ roll
     - **axis** (int|list|tuple，可选) – 滚动轴。默认值为 None。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
+下图展示了一个形状为 ``[[1,2,3],[4,5,6],[7,8,9]]`` 的二维张量通过 ``roll`` 操作转变为形状不同的张量。
 
+.. image:: ../../images/api_legend/roll.png
+    :width: 700
+    :align: center
+    :alt: 图例
+
+- 当 ``axis = None`` 时，张量会被展平成一维，然后进行循环滚动，再恢复原状
+- 当 ``axis=0`` 时，张量沿着 0 轴方向进行循环滚动
+- 当 ``axis=1`` 时，张量沿着 1 轴方向进行循环滚动
+
+由于 ``axis`` 参数的取值不同，对应的滚动操作也不同，由图可以看到每个元素在不同滚动操作下的位置变化。
 
 返回
 :::::::::

diff --git a/docs/images/api_legend/roll.png b/docs/images/api_legend/roll.png