!32115 modify page display

Merge pull request !32115 from 俞涵/code_docs_328
2022-03-29 02:54:50 +00:00 · 2022-03-29 02:54:50 +00:00 · ff4974cca4
parent f9f53bce57 33fc1b0f31
commit ff4974cca4
10 changed files with 32 additions and 28 deletions
--- a/docs/api/api_python/dataset/mindspore.dataset.OBSMindDataset.rst
+++ b/docs/api/api_python/dataset/mindspore.dataset.OBSMindDataset.rst
@ -40,5 +40,4 @@
        - 如果线下训练，建议为每次训练设置 `BATCH_JOB_ID` 环境变量。
        - 分布式训练中，假如使用多个节点（服务器），则必须使用每个节点全部的8张卡。如果只有一个节点（服务器），则没有这样的限制。

-
    .. include:: mindspore.dataset.Dataset.sync_wait_dataset.rst
--- a/docs/api/api_python/mindspore.nn.rst
+++ b/docs/api/api_python/mindspore.nn.rst
@ -289,6 +289,8 @@ LearningRateSchedule类

 .. mscnplatformautosummary::
    :toctree: nn
+    :nosignatures:
+    :template: classtemplate.rst

    mindspore.nn.CosineDecayLR
    mindspore.nn.ExponentialDecayLR
@ -319,6 +321,8 @@ Dynamic LR函数
    
 .. mscnplatformautosummary::
    :toctree: nn
+    :nosignatures:
+    :template: classtemplate.rst

    mindspore.nn.cosine_decay_lr
    mindspore.nn.exponential_decay_lr
@ -402,6 +406,8 @@ Dynamic LR函数

 .. mscnplatformautosummary::
    :toctree: nn
+    :nosignatures:
+    :template: classtemplate.rst

    mindspore.nn.Jvp
    mindspore.nn.Vjp
--- a/docs/api/api_python/nn/mindspore.nn.Cell.rst
+++ b/docs/api/api_python/nn/mindspore.nn.Cell.rst
@ -105,8 +105,7 @@
        - **inputs** (tuple) – Cell的输入。
        
        .. note::
-
-        这是一个实验接口，可能会被更改或者删除。
+            这是一个实验接口，可能会被更改或者删除。

    .. py:method:: compile(*inputs)

@ -120,7 +119,8 @@

        编译并运行Cell，输入需与construct中定义的输入一致。

-        .. note::不推荐使用该函数，建议直接调用Cell实例
+        .. note::
+            不推荐使用该函数，建议直接调用Cell实例。

        **参数：**

@ -134,7 +134,8 @@

        定义要执行的计算逻辑。所有子类都必须重写此方法。

-        .. note::当前不支持inputs同时输入tuple类型和非tuple类型。
+        .. note::
+            当前不支持inputs同时输入tuple类型和非tuple类型。

        **参数：**

@ -196,8 +197,7 @@
        Tuple类型，编译计算图所设置的输入。

        .. note::
-
-        这是一个实验接口，可能会被更改或者删除。
+            这是一个实验接口，可能会被更改或者删除。

    .. py:method:: infer_param_pipeline_stage()

--- a/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Bernoulli.rst
+++ b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Bernoulli.rst
@ -42,7 +42,7 @@ mindspore.nn.probability.distribution.Bernoulli

        Tensor，累积分布函数的值。

-    .. py:method:: cross_entropy(dist, probs1_b, probs1)
+    .. py:method:: cross_entropy(dist, probs1_b, probs1_a)

        计算分布a和b之间的交叉熵。

@ -50,7 +50,7 @@ mindspore.nn.probability.distribution.Bernoulli

        - **dist** (str) - 分布的类型。
        - **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
-        - **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
+        - **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值：None。

        **返回：**

@ -62,13 +62,13 @@ mindspore.nn.probability.distribution.Bernoulli

        **参数：**

-        - **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。默认值：None。
+        - **probs1** (Tensor) - 对比分布的伯努利实验成功的概率。默认值：None。

        **返回：**

        Tensor，熵的值。

-    .. py:method:: kl_loss(dist, probs1)
+    .. py:method:: kl_loss(dist, probs1_b, probs1_a)

        计算KL散度，即KL(a||b)。

@ -76,7 +76,7 @@ mindspore.nn.probability.distribution.Bernoulli

        - **dist** (str) - 分布的类型。
        - **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
-        - **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
+        - **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值：None。

        **返回：**

--- a/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Beta.rst
+++ b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Beta.rst
@ -31,11 +31,11 @@ mindspore.nn.probability.distribution.Beta
    .. py:method:: concentration0
        :property:

-      返回concentration0（也称为 Beta 分布的 beta）。
+        返回concentration0（也称为 Beta 分布的 beta）。

-    **返回：**
+        **返回：**

-    Tensor，concentration0 的值。
+        Tensor，concentration0 的值。

    .. py:method:: concentration1
        :property:
--- a/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Categorical.rst
+++ b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Categorical.rst
@ -29,7 +29,7 @@ mindspore.nn.probability.distribution.Categorical

        Tensor，事件发生的概率。

-   .. py:method:: cdf(value, probs)
+    .. py:method:: cdf(value, probs)

        在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。

--- a/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Geometric.rst
+++ b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Geometric.rst
@ -32,7 +32,7 @@ mindspore.nn.probability.distribution.Geometric

        Tensor，伯努利试验成功的概率值。

-   .. py:method:: cdf(value, probs)
+    .. py:method:: cdf(value, probs)

        在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。

--- a/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Poisson.rst
+++ b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Poisson.rst
@ -35,7 +35,7 @@ mindspore.nn.probability.distribution.Poisson

        Tensor，rate 参数的值。

-   .. py:method:: cdf(value, rate)
+    .. py:method:: cdf(value, rate)

        在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。

--- a/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.TransformedDistribution.rst
+++ b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.TransformedDistribution.rst
@ -49,7 +49,7 @@ mindspore.nn.probability.distribution.TransformedDistribution

        Bool, 概率映射函数为线性映射则返回True，否则返回False。

-   .. py:method:: cdf(value)
+    .. py:method:: cdf(value)

        在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。

--- a/docs/api/api_python/ops/mindspore.ops.Custom.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Custom.rst
@ -11,16 +11,15 @@ mindspore.ops.Custom
        这是一个实验性接口，后续可能删除或修改。

    .. note::
+        不同自定义算子的函数类型（func_type)支持的平台类型不同。每种类型支持的平台如下：

-    不同自定义算子的函数类型（func_type)支持的平台类型不同。每种类型支持的平台如下：
-
-    - "hybrid": ["Ascend", "GPU"].
-    - "akg": ["Ascend", "GPU"].
-    - "tbe": ["Ascend"].
-    - "aot": ["GPU", "CPU"].
-    - "pyfunc": ["CPU"].
-    - "julia": ["CPU"].
-    - "aicpu": ["Ascend"].
+        - "hybrid": ["Ascend", "GPU"].
+        - "akg": ["Ascend", "GPU"].
+        - "tbe": ["Ascend"].
+        - "aot": ["GPU", "CPU"].
+        - "pyfunc": ["CPU"].
+        - "julia": ["CPU"].
+        - "aicpu": ["Ascend"].

    **参数：**