From 9283a400ff0c369374c0c8e1d88428f6f2dd4e8e Mon Sep 17 00:00:00 2001
From: yaoxuefeng <yaoxuefeng@baidu.com>
Date: Sun, 6 Sep 2020 21:33:12 +0800
Subject: [PATCH] add cuda genrator get/set_cuda_rng_state doc (#2542)

---
 doc/fluid/api_cn/framework_cn.rst             |  2 ++
 .../framework_cn/get_cuda_rng_state_cn.rst    | 24 ++++++++++++++++++
 .../framework_cn/set_cuda_rng_state_cn.rst    | 25 +++++++++++++++++++
 doc/fluid/api_cn/paddle_cn.rst                |  2 ++
 .../paddle_cn/get_cuda_rng_state_cn.rst       |  7 ++++++
 .../paddle_cn/set_cuda_rng_state_cn.rst       |  7 ++++++
 6 files changed, 67 insertions(+)
 create mode 100644 doc/fluid/api_cn/framework_cn/get_cuda_rng_state_cn.rst
 create mode 100644 doc/fluid/api_cn/framework_cn/set_cuda_rng_state_cn.rst
 create mode 100644 doc/fluid/api_cn/paddle_cn/get_cuda_rng_state_cn.rst
 create mode 100644 doc/fluid/api_cn/paddle_cn/set_cuda_rng_state_cn.rst

diff --git a/doc/fluid/api_cn/framework_cn.rst b/doc/fluid/api_cn/framework_cn.rst
index ef60b9dcc..54cf4aa25 100644
--- a/doc/fluid/api_cn/framework_cn.rst
+++ b/doc/fluid/api_cn/framework_cn.rst
@@ -24,6 +24,8 @@ paddle.framework
     framework_cn/global_scope_cn.rst
     framework_cn/gradients_cn.rst
     framework_cn/manual_seed_cn.rst
+    framework_cn/get_cuda_rng_state_cn.rst
+    framework_cn/set_cuda_rng_state_cn.rst
     framework_cn/name_scope_cn.rst
     framework_cn/ParallelExecutor_cn.rst
     framework_cn/ParamAttr_cn.rst
diff --git a/doc/fluid/api_cn/framework_cn/get_cuda_rng_state_cn.rst b/doc/fluid/api_cn/framework_cn/get_cuda_rng_state_cn.rst
new file mode 100644
index 000000000..35d76080f
--- /dev/null
+++ b/doc/fluid/api_cn/framework_cn/get_cuda_rng_state_cn.rst
@@ -0,0 +1,24 @@
+.. _cn_api_paddle_framework_get_cuda_rng_state:
+
+get_cuda_rng_state
+-------------------------------
+
+.. py:function:: paddle.framework.get_cuda_rng_state()
+
+
+获取cuda随机数生成器的状态信息
+
+
+参数:
+
+     无
+
+返回: 
+     GeneratorState：对象
+
+**代码示例**：
+
+.. code-block:: python
+
+    import paddle
+    sts = paddle.get_cuda_rng_state()
diff --git a/doc/fluid/api_cn/framework_cn/set_cuda_rng_state_cn.rst b/doc/fluid/api_cn/framework_cn/set_cuda_rng_state_cn.rst
new file mode 100644
index 000000000..e63225b81
--- /dev/null
+++ b/doc/fluid/api_cn/framework_cn/set_cuda_rng_state_cn.rst
@@ -0,0 +1,25 @@
+.. _cn_api_paddle_framework_set_cuda_rng_state:
+
+set_cuda_rng_state
+-------------------------------
+
+.. py:function:: paddle.framework.set_cuda_rng_state(state_list)
+
+
+设置cuda随机数生成器的状态信息
+
+
+参数:
+
+     - **state_list** (list [GeneratorState]) - 需要设置的随机数生成器状态信息列表，通过get_cuda_rng_state()获取。
+
+返回: 
+     无
+
+**代码示例**：
+
+.. code-block:: python
+
+    import paddle
+    sts = paddle.get_cuda_rng_state()
+    paddle.set_cuda_rng_state(sts)
diff --git a/doc/fluid/api_cn/paddle_cn.rst b/doc/fluid/api_cn/paddle_cn.rst
index 2e6632b2b..2ce64a6a7 100644
--- a/doc/fluid/api_cn/paddle_cn.rst
+++ b/doc/fluid/api_cn/paddle_cn.rst
@@ -96,6 +96,8 @@ paddle
 	paddle_cn/logsumexp_cn.rst
 	paddle_cn/log_cn.rst
 	paddle_cn/manual_seed_cn.rst
+	paddle_cn/get_cuda_rng_state_cn.rst
+	paddle_cn/set_cuda_rng_state_cn.rst
 	paddle_cn/masked_select_cn.rst
 	paddle_cn/matmul_cn.rst
 	paddle_cn/max_cn.rst
diff --git a/doc/fluid/api_cn/paddle_cn/get_cuda_rng_state_cn.rst b/doc/fluid/api_cn/paddle_cn/get_cuda_rng_state_cn.rst
new file mode 100644
index 000000000..92d9ee845
--- /dev/null
+++ b/doc/fluid/api_cn/paddle_cn/get_cuda_rng_state_cn.rst
@@ -0,0 +1,7 @@
+.. _cn_api_paddle_cn_get_cuda_rng_state:
+
+get_cuda_rng_state
+-------------------------------
+:doc_source: paddle.framework.get_cuda_rng_state
+
+
diff --git a/doc/fluid/api_cn/paddle_cn/set_cuda_rng_state_cn.rst b/doc/fluid/api_cn/paddle_cn/set_cuda_rng_state_cn.rst
new file mode 100644
index 000000000..f628ae3c3
--- /dev/null
+++ b/doc/fluid/api_cn/paddle_cn/set_cuda_rng_state_cn.rst
@@ -0,0 +1,7 @@
+.. _cn_api_paddle_cn_set_cuda_rng_state:
+
+set_cuda_rng_state
+-------------------------------
+:doc_source: paddle.framework.set_cuda_rng_state
+
+
-- 
GitLab