From 01aa45d22a255541f41125c19bb1a2deed78a15a Mon Sep 17 00:00:00 2001
From: yukavio <kavioyu@gmail.com>
Date: Sun, 16 Aug 2020 13:48:59 +0800
Subject: [PATCH] Create one_hot_cn.rst

create new doc for nn.functional.one_hot
---
 .../api_cn/nn_cn/functional_cn/one_hot_cn.rst | 64 +++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 doc/fluid/api_cn/nn_cn/functional_cn/one_hot_cn.rst

diff --git a/doc/fluid/api_cn/nn_cn/functional_cn/one_hot_cn.rst b/doc/fluid/api_cn/nn_cn/functional_cn/one_hot_cn.rst
new file mode 100644
index 000000000..be8e99caf
--- /dev/null
+++ b/doc/fluid/api_cn/nn_cn/functional_cn/one_hot_cn.rst
@@ -0,0 +1,64 @@
+.. _cn_api_fluid_one_hot:
+
+one_hot
+-------------------------------
+
+.. py:function:: paddle.fluid.one_hot(x, num_classes)
+
+:alias_main: paddle.nn.functional.one_hot
+:alias: paddle.nn.functional.one_hot,paddle.nn.functional.common.one_hot
+:old_api: paddle.fluid.one_hot
+
+
+
+该OP将输入（x）中的每个id转换为一个one-hot向量，其长度为 ``num_classes`` ，该id对应的向量维度上的值为1，其余维度的值为0。
+
+输出的Tensor的shape是在输入shape的最后一维后面添加了num_classes的维度。
+
+- 示例1：
+
+.. code-block:: python
+
+  输入：
+    X.shape = [4]
+    X.data = [1, 1, 3, 0]
+    num_classes = 4
+
+  输出：
+    Out.shape = [4, 4]
+    Out.data = [[0., 1., 0., 0.],
+                [0., 1., 0., 0.],
+                [0., 0., 0., 1.],
+                [1., 0., 0., 0.]]
+
+
+- 示例2：
+
+.. code-block:: python
+  
+  输入：
+    X.shape = [4]
+    X.data = [1, 1, 5, 0]
+    num_classes = 4
+
+  输出：抛出 Illegal value 的异常
+    X中第2维的值是5，超过了num_classes，因此抛异常。  
+
+
+参数：
+    - **x** (Tensor) - 维度为 :math:`[N_1, ..., N_n]` 的多维Tensor，维度至少1维。数据类型为int32或int64。
+    - **num_classes** (int) - 用于定义一个one-hot向量的长度。若输入为词id，则 ``num_classes`` 通常取值为词典大小。
+    - **allow_out_of_range** (bool) - 指明x中所包含的id值是否可以大于num_classes值。当超过num_classes时，如果 `allow_out_of_range` 为False，则会抛出 `Illegal value` 的异常；如果设置为True，该id对应的向量为0向量。默认值为False。
+
+返回：转换后的one_hot Tensor，数据类型为float32。
+
+返回类型：Tensor
+
+**代码示例**：
+
+.. code-block:: python
+
+    import paddle.fluid as fluid
+    # 该代码对应上述第一个示例，其中输入label的shape是[4]，输出one_hot_label的shape是[4, 4]
+    label = fluid.layers.data(name="label", shape=[4], append_batch_size=False, dtype="int64")
+    one_hot_label = fluid.one_hot(x=label, num_classes=4)
-- 
GitLab