[Docathon][Add CN Doc No.10-11] (PaddlePaddle#6363)

* add docs * Update Overview_cn.rst
MarisaSparkL · Jan 9, 2024 · f3f9ebb · f3f9ebb
1 parent 6283037
commit f3f9ebb
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst
@@ -463,13 +463,15 @@ framework 相关
     " :ref:`paddle.disable_static <cn_api_paddle_disable_static>` ", "关闭静态图模式"
     " :ref:`paddle.enable_static <cn_api_paddle_enable_static>` ", "开启静态图模式"
     " :ref:`paddle.get_default_dtype <cn_api_paddle_get_default_dtype>` ", "得到当前全局的 dtype"
+    " :ref:`paddle.get_rng_state <cn_api_paddle_get_rng_state>` ", "获取指定设备的随机数生成器的所有随机状态。"
     " :ref:`paddle.grad <cn_api_paddle_grad>` ", "对于每个 inputs ，计算所有 outputs 相对于其的梯度和"
     " :ref:`paddle.in_dynamic_mode <cn_api_paddle_in_dynamic_mode>` ", "查看 paddle 当前是否在动态图模式中运行"
     " :ref:`paddle.load <cn_api_paddle_load>` ", "从指定路径载入可以在 paddle 中使用的对象实例"
     " :ref:`paddle.no_grad <cn_api_paddle_no_grad>` ", "创建一个上下文来禁用动态图梯度计算"
     " :ref:`paddle.ParamAttr <cn_api_paddle_ParamAttr>` ", "创建一个参数属性对象"
     " :ref:`paddle.save <cn_api_paddle_save>` ", "将对象实例 obj 保存到指定的路径中"
     " :ref:`paddle.set_default_dtype <cn_api_paddle_set_default_dtype>` ", "设置默认的全局 dtype。"
+    " :ref:`paddle.set_rng_state <cn_api_paddle_set_rng_state>` ", "设置默认的全局设备生成器状态。"
     " :ref:`paddle.set_grad_enabled <cn_api_paddle_set_grad_enabled>` ", "创建启用或禁用动态图梯度计算的上下文"
     " :ref:`paddle.is_grad_enabled <cn_api_paddle_is_grad_enabled>` ", "判断当前动态图下是否启用了计算梯度模式。"
     " :ref:`paddle.set_printoptions <cn_api_paddle_set_printoptions>` ", "设置 paddle 中 Tensor 的打印配置选项"

diff --git a/docs/api/paddle/get_rng_state_cn.rst b/docs/api/paddle/get_rng_state_cn.rst
@@ -0,0 +1,20 @@
+.. _cn_api_paddle_get_rng_state:
+
+get_rng_state
+-------------------------------
+.. py:function:: paddle.get_rng_state(device=None)
+
+获取指定设备的随机数生成器的所有随机状态。
+
+参数
+::::::::::::
+    - **device** (str) - 此参数决定了具体的运行设备。可以是 ``cpu``、``gpu``、``xpu``。默认值为 None。如果为 None，则返回当前设备（由 ``set_device`` 指定）的生成器。
+
+返回
+::::::::::::
+    - GeneratorState：对象。
+
+代码示例
+::::::::::::
+
+COPY-FROM: paddle.get_rng_state
diff --git a/docs/api/paddle/set_rng_state_cn.rst b/docs/api/paddle/set_rng_state_cn.rst
@@ -0,0 +1,23 @@
+.. _cn_api_paddle_set_rng_state:
+
+set_rng_state
+-------------------------------
+
+.. py:function:: paddle.set_rng_state(state_list, device=None)
+
+为所有设备生成器设置生成器状态。
+
+参数
+::::::::::::
+    - **state_list** (list|tuple) - 要设置回设备生成器的设备状态。state_list 是从 ``get_rng_state()`` 获取的。
+    - **device** (str) - 此参数决定了具体的运行设备。可以是 ``cpu``、``gpu``、``xpu``。默认值为 None。如果为 None，则返回当前设备（由 ``set_device`` 指定）的生成器。
+
+返回
+::::::::::::
+    - 无。
+
+
+代码示例
+::::::::::::
+
+COPY-FROM: paddle.set_rng_state