!27172 modify api annotation

Merge pull request !27172 from xumengjuan1/code_docs_xmj2

docs/api/api_python/mindspore/mindspore.context.txt

@@ -217,4 +217,4 @@ set_context(**kwargs)
         >>> context.set_context(grad_for_scalar=True)
         >>> context.set_context(save_compile_cache=True)
         >>> context.set_context(load_compile_cache=True)
-        >>> context.set_context(pynative_synchronize=True)
+        >>> context.set_context(pynative_synchronize=True)

docs/api/api_python/mindspore/mindspore.dtype.rst

@@ -3,99 +3,98 @@ mindspore.dtype
 
 .. py:class:: mindspore.dtype
   
-  创建一个MindSpore数据类型的对象。
+    创建一个MindSpore数据类型的对象。
 
-  `dtype` 的实际路径为 `/mindspore/common/dtype.py` ，运行以下命令导入环境：
+    `dtype` 的实际路径为 `/mindspore/common/dtype.py` ，运行以下命令导入环境：
   
-  .. code-block::
+    .. code-block::
   
-      from mindspore import dtype as mstype
+        from mindspore import dtype as mstype
   
-  * **数值型**
-
-    目前，MindSpore支持 ``Int``，``Uint`` 和 ``Float`` 数据类型，详情请参照以下表格。
+    - **数值型**
 
-    ==============================================   =============================
-    定义                                              描述
-    ==============================================   =============================
-    ``mindspore.int8`` ,  ``mindspore.byte``         8位整型数
-    ``mindspore.int16`` ,  ``mindspore.short``       16位整型数 
-    ``mindspore.int32`` ,  ``mindspore.intc``        32位整型数
-    ``mindspore.int64`` ,  ``mindspore.intp``        64位整型数
-    ``mindspore.uint8`` ,  ``mindspore.ubyte``       无符号8位整型数
-    ``mindspore.uint16`` ,  ``mindspore.ushort``     无符号16位整型数
-    ``mindspore.uint32`` ,  ``mindspore.uintc``      无符号32位整型数
-    ``mindspore.uint64`` ,  ``mindspore.uintp``      无符号64位整型数
-    ``mindspore.float16`` ,  ``mindspore.half``      16位浮点数
-    ``mindspore.float32`` ,  ``mindspore.single``    32位浮点数
-    ``mindspore.float64`` ,  ``mindspore.double``    64位浮点数
-    ``mindspore.complex64``                          64位复数
-    ``mindspore.complex128``                         128位复数
-    ==============================================   =============================
-  
-  * **其他类型**
+      目前，MindSpore支持 ``Int``，``Uint`` 和 ``Float`` 数据类型，详情请参照以下表格。
   
-    除数值型以外的其他数据类型，请参照以下表格。
+      ==============================================   =============================
+      定义                                              描述
+      ==============================================   =============================
+      ``mindspore.int8`` ,  ``mindspore.byte``         8位整型数
+      ``mindspore.int16`` ,  ``mindspore.short``       16位整型数 
+      ``mindspore.int32`` ,  ``mindspore.intc``        32位整型数
+      ``mindspore.int64`` ,  ``mindspore.intp``        64位整型数
+      ``mindspore.uint8`` ,  ``mindspore.ubyte``       无符号8位整型数
+      ``mindspore.uint16`` ,  ``mindspore.ushort``     无符号16位整型数
+      ``mindspore.uint32`` ,  ``mindspore.uintc``      无符号32位整型数
+      ``mindspore.uint64`` ,  ``mindspore.uintp``      无符号64位整型数
+      ``mindspore.float16`` ,  ``mindspore.half``      16位浮点数
+      ``mindspore.float32`` ,  ``mindspore.single``    32位浮点数
+      ``mindspore.float64`` ,  ``mindspore.double``    64位浮点数
+      ``mindspore.complex64``                          64位复数
+      ``mindspore.complex128``                         128位复数
+      ==============================================   =============================
   
-    ============================   =================
-    类型                            描述
-    ============================   =================
-    ``Tensor``                      MindSpore中的张量类型。数据格式采用NCHW。详情请参考 `tensor <https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/tensor.py>_`.
-    ``bool_``                       布尔型，值为 ``True`` 或者 ``False`` 。
-    ``int_``                        整数标量。
-    ``uint``                        无符号整数标量。
-    ``float_``                      浮点标量。
-    ``complex``                     复数标量。
-    ``number``                      数值型, 包括 ``int_`` , ``uint`` , ``float_`` , ``complex`` 和 ``bool_``。
-    ``list_``                       由 ``tensor`` 构造的列表，例如 ``List[T0,T1,...,Tn]`` ，其中元素 ``Ti`` 可以是不同的类型。
-    ``tuple_``                      由 ``tensor`` 构造的元组，例如 ``Tuple[T0,T1,...,Tn]`` ，其中元素 ``Ti`` 可以是不同的类型。
-    ``function``                    函数类型。 两种返回方式，当function不是None时，直接返回function，另一种当function为None时返回function(参数: List[T0,T1,...,Tn], 返回值: T)。
-    ``type_type``                   类型的类型定义。
-    ``type_none``                   没有匹配的返回类型，对应 Python 中的 ``type(None)``。
-    ``symbolic_key``                在 ``env_type`` 中用作变量的键的变量的值。
-    ``env_type``                    用于存储函数的自由变量的梯度，其中键是自由变量节点的``symbolic_key``，值是梯度。
-    ============================   =================
+    - **其他类型**
   
-  * **树形拓扑**
+      除数值型以外的其他数据类型，请参照以下表格。
+    
+      ============================   =================
+      类型                            描述
+      ============================   =================
+      ``Tensor``                      MindSpore中的张量类型。数据格式采用NCHW。详情请参考 `tensor <https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/tensor.py>_`.
+      ``bool_``                       布尔型，值为 ``True`` 或者 ``False`` 。
+      ``int_``                        整数标量。
+      ``uint``                        无符号整数标量。
+      ``float_``                      浮点标量。
+      ``complex``                     复数标量。
+      ``number``                      数值型, 包括 ``int_`` , ``uint`` , ``float_`` , ``complex`` 和 ``bool_``。
+      ``list_``                       由 ``tensor`` 构造的列表，例如 ``List[T0,T1,...,Tn]`` ，其中元素 ``Ti`` 可以是不同的类型。
+      ``tuple_``                      由 ``tensor`` 构造的元组，例如 ``Tuple[T0,T1,...,Tn]`` ，其中元素 ``Ti`` 可以是不同的类型。
+      ``function``                    函数类型。 两种返回方式，当function不是None时，直接返回function，另一种当function为None时返回function(参数: List[T0,T1,...,Tn], 返回值: T)。
+      ``type_type``                   类型的类型定义。
+      ``type_none``                   没有匹配的返回类型，对应 Python 中的 ``type(None)``。
+      ``symbolic_key``                在 ``env_type`` 中用作变量的键的变量的值。
+      ``env_type``                    用于存储函数的自由变量的梯度，其中键是自由变量节点的``symbolic_key``，值是梯度。
+      ============================   =================
   
-    以上定义的数据类型遵从如下的树形拓扑结构：
+    - **树形拓扑**
   
-    .. code-block::
-    
+      以上定义的数据类型遵从如下的树形拓扑结构：
     
-        └─────── number
-            │   ├─── bool_
-            │   ├─── int_
-            │   │   ├─── int8, byte
-            │   │   ├─── int16, short
-            │   │   ├─── int32, intc
-            │   │   └─── int64, intp
-            │   ├─── uint
-            │   │   ├─── uint8, ubyte
-            │   │   ├─── uint16, ushort
-            │   │   ├─── uint32, uintc
-            │   │   └─── uint64, uintp
-            │   ├─── float_
-            │   │    ├─── float16
-            │   │    ├─── float32
-            │   │    └─── float64
-            │   └─── complex
-            │       ├─── complex64
-            │       └─── complex128
-            ├─── tensor
-            │   ├─── Array[Float32]
-            │   └─── ...
-            ├─── list_
-            │   ├─── List[Int32,Float32]
-            │   └─── ...
-            ├─── tuple_
-            │   ├─── Tuple[Int32,Float32]
-            │   └─── ...
-            ├─── function
-            │   ├─── Func
-            │   ├─── Func[(Int32, Float32), Int32]
-            │   └─── ...
-            ├─── type_type
-            ├─── type_none
-            ├─── symbolic_key
-            └─── env_type
+      .. code-block::
+      
+          └─────── number
+              │   ├─── bool_
+              │   ├─── int_
+              │   │   ├─── int8, byte
+              │   │   ├─── int16, short
+              │   │   ├─── int32, intc
+              │   │   └─── int64, intp
+              │   ├─── uint
+              │   │   ├─── uint8, ubyte
+              │   │   ├─── uint16, ushort
+              │   │   ├─── uint32, uintc
+              │   │   └─── uint64, uintp
+              │   ├─── float_
+              │   │    ├─── float16
+              │   │    ├─── float32
+              │   │    └─── float64
+              │   └─── complex
+              │       ├─── complex64
+              │       └─── complex128
+              ├─── tensor
+              │   ├─── Array[Float32]
+              │   └─── ...
+              ├─── list_
+              │   ├─── List[Int32,Float32]
+              │   └─── ...
+              ├─── tuple_
+              │   ├─── Tuple[Int32,Float32]
+              │   └─── ...
+              ├─── function
+              │   ├─── Func
+              │   ├─── Func[(Int32, Float32), Int32]
+              │   └─── ...
+              ├─── type_type
+              ├─── type_none
+              ├─── symbolic_key
+              └─── env_type

docs/api/api_python/mindspore/mindspore.dtype_to_pytype.rst

@@ -7,8 +7,8 @@ mindspore.dtype_to_pytype
 
     **参数：**
 
-        **type_** (mindspore.dtype) – MindSpore中的dtype。
+    **type_** (mindspore.dtype) – MindSpore中的dtype。
 
     **返回：**
 
-        Python的数据类型。
+    Python的数据类型。

docs/api/api_python/mindspore/mindspore.get_level.txt

@@ -1,15 +1,20 @@
-mindspore.get_level()
+mindspore.get_level
+======================
+
+.. py:class:: mindspore.get_level()
 
     获取日志记录器的级别。
 
-    返回：
-        string，日志级别包括4(EXCEPTION)、3(ERROR)、2(WARNING)、1(INFO)和0(DEBUG)。
+    **返回：**
+
+    string，日志级别包括4(EXCEPTION)、3(ERROR)、2(WARNING)、1(INFO)和0(DEBUG)。
 
-    样例：
-        >>> import os
-        >>> os.environ['GLOG_v'] = '0'
-        >>> from mindspore import log as logger
-        >>> level = logger.get_level()
-        >>> print(level)
-        '0'
+    **样例：**
+    
+    >>> import os
+    >>> os.environ['GLOG_v'] = '0'
+    >>> from mindspore import log as logger
+    >>> level = logger.get_level()
+    >>> print(level)
+    '0'
     

docs/api/api_python/mindspore/mindspore.get_log_config.txt

@@ -1,21 +1,26 @@
-mindspore.get_log_config()
+mindspore.get_log_config
+=========================
+
+.. py:class:: mindspore.get_log_config()
 
     获取日志配置。
 
-    返回：
-        Dict，日志配置字典。
+    **返回：**
+
+    Dict，日志配置字典。
+
+    **样例：**
 
-    样例：
-        >>> import os
-        >>> os.environ['GLOG_v'] = '1'
-        >>> os.environ['GLOG_logtostderr'] = '0'
-        >>> os.environ['GLOG_log_dir'] = '/var/log'
-        >>> os.environ['logger_maxBytes'] = '5242880'
-        >>> os.environ['logger_backupCount'] = '10'
-        >>> os.environ['GLOG_stderrthreshold'] = '2'
-        >>> from mindspore import log as logger
-        >>> config= logger.get_log_config()
-        >>> print(config)
-        {'GLOG_v': '1', 'GLOG_logtostderr': '0', 'GLOG_log_dir': '/var/log',
-         'logger_maxBytes': '5242880', 'logger_backupCount': '10', 'GLOG_stderrthreshold': '2'}
+    >>> import os
+    >>> os.environ['GLOG_v'] = '1'
+    >>> os.environ['GLOG_logtostderr'] = '0'
+    >>> os.environ['GLOG_log_dir'] = '/var/log'
+    >>> os.environ['logger_maxBytes'] = '5242880'
+    >>> os.environ['logger_backupCount'] = '10'
+    >>> os.environ['GLOG_stderrthreshold'] = '2'
+    >>> from mindspore import log as logger
+    >>> config= logger.get_log_config()
+    >>> print(config)
+    {'GLOG_v': '1', 'GLOG_logtostderr': '0', 'GLOG_log_dir': '/var/log',
+     'logger_maxBytes': '5242880', 'logger_backupCount': '10', 'GLOG_stderrthreshold': '2'}
     

docs/api/api_python/mindspore/mindspore.get_py_obj_dtype.rst

@@ -7,8 +7,8 @@ mindspore.get_py_obj_dtype
 
     **参数：**
 
-        **obj** (type) – Python数据对象，或在Python环境中定义的变量。
+    **obj** (type) – Python数据对象，或在Python环境中定义的变量。
 
     **返回：**
 
-        MindSpore的数据类型。
+    MindSpore的数据类型。

docs/api/api_python/mindspore/mindspore.get_seed.rst

@@ -7,4 +7,4 @@ mindspore.get_seed
 
     **返回：**
 
-        int，随机种子。
+    int，随机种子。

docs/api/api_python/mindspore/mindspore.issubclass_.rst

@@ -7,9 +7,9 @@ mindspore.issubclass\_
 
     **参数：**
 
-        - **type_** (mindspore.dtype) – MindSpore中的目标dtype。
-        - **dtype** (mindspore.dtype) – dtype的比较对象。
+    - **type_** (mindspore.dtype) – MindSpore中的目标dtype。
+    - **dtype** (mindspore.dtype) – dtype的比较对象。
 
     **返回：**
 
-        bool，True或False。
+    bool，True或False。

docs/api/api_python/mindspore/mindspore.pytype_to_dtype.rst

@@ -7,8 +7,8 @@ mindspore.pytype_to_dtype
 
     **参数：**
 
-        **obj** (type) – Python数据对象。
+    **obj** (type) – Python数据对象。
 
     **返回:**
 
-        MindSpore的数据类型。
+    MindSpore的数据类型。

docs/api/api_python/mindspore/mindspore.run_check.rst

@@ -7,9 +7,7 @@ mindspore.run_check
 
     **样例:**
 
-    .. code-block::
-
-        >>> import mindspore
-        >>> mindspore.run_check()
-        MindSpore version: xxx
-        The result of multiplication calculation is correct, MindSpore has been installed successfully!
+    >>> import mindspore
+    >>> mindspore.run_check()
+    MindSpore version: xxx
+    The result of multiplication calculation is correct, MindSpore has been installed successfully!

docs/api/api_python/mindspore/mindspore.set_seed.rst

@@ -8,20 +8,17 @@ mindspore.set_seed
     .. note:: 
 
         全局种子可用于numpy.random,mindspore.common.Initializer,mindspore.ops.composite.random_ops以及mindspore.nn.probability.distribution。
-
         如果没有设置全局种子，这些包将会各自使用自己的种子，numpy.random和mindspore.common.Initializer将会随机选择种子值，mindspore.ops.composite.random_ops和mindspore.nn.probability.distribution将会使用零作为种子值。
-        
         numpy.random.seed()设置的种子仅能被numpy.random使用，而这个API设置的种子也可被numpy.random使用，因此推荐使用这个API设置所有的种子。
 
     **参数：**
 
-        **seed** (int) – 设置的全局种子。
+    **seed** (int) – 设置的全局种子。
 
     **异常:**
 
-        - **ValueError** – 种子值非法 (小于0)。
-
-        - **TypeError** – 种子值非整型数。
+    - **ValueError** – 种子值非法 (小于0)。
+    - **TypeError** – 种子值非整型数。
 
 
     **样例:**