From fa41c9cf1bde454f086a0ac9fda020bb2a2dcc5e Mon Sep 17 00:00:00 2001 From: zhangyi Date: Tue, 15 Sep 2020 16:11:43 +0800 Subject: [PATCH] Adjust the structure of API's contents in web. --- .../mindspore/mindspore.dataset.config.rst | 5 - .../python/mindspore/mindspore.dataset.rst | 7 ++ .../api/python/mindspore/mindspore.dtype.rst | 111 ----------------- .../mindspore/mindspore.ops.composite.rst | 5 - .../mindspore/mindspore.ops.operations.rst | 5 - .../python/mindspore/mindspore.parallel.rst | 5 + .../api/python/mindspore/mindspore.rst | 115 +++++++++++++++++- .../api/python/mindspore/mindspore.train.rst | 8 +- api/source_en/index.rst | 16 ++- .../mindspore/mindspore.dataset.config.rst | 5 - .../api/python/mindspore/mindspore.dtype.rst | 112 ----------------- .../mindspore/mindspore.ops.composite.rst | 5 - .../mindspore/mindspore.ops.operations.rst | 5 - .../python/mindspore/mindspore.parallel.rst | 5 + .../api/python/mindspore/mindspore.rst | 115 +++++++++++++++++- .../api/python/mindspore/mindspore.train.rst | 8 +- api/source_zh_cn/index.rst | 15 +-- .../_static/logo_online_experience.png | Bin 0 -> 1991 bytes .../source_zh_cn/quick_start/quick_start.md | 10 +- 19 files changed, 270 insertions(+), 287 deletions(-) delete mode 100644 api/source_en/api/python/mindspore/mindspore.dataset.config.rst delete mode 100644 api/source_en/api/python/mindspore/mindspore.dtype.rst delete mode 100644 api/source_en/api/python/mindspore/mindspore.ops.composite.rst delete mode 100644 api/source_en/api/python/mindspore/mindspore.ops.operations.rst create mode 100644 api/source_en/api/python/mindspore/mindspore.parallel.rst delete mode 100644 api/source_zh_cn/api/python/mindspore/mindspore.dataset.config.rst delete mode 100644 api/source_zh_cn/api/python/mindspore/mindspore.dtype.rst delete mode 100644 api/source_zh_cn/api/python/mindspore/mindspore.ops.composite.rst delete mode 100644 api/source_zh_cn/api/python/mindspore/mindspore.ops.operations.rst create mode 100644 api/source_zh_cn/api/python/mindspore/mindspore.parallel.rst create mode 100644 tutorials/source_zh_cn/_static/logo_online_experience.png diff --git a/api/source_en/api/python/mindspore/mindspore.dataset.config.rst b/api/source_en/api/python/mindspore/mindspore.dataset.config.rst deleted file mode 100644 index 55cf3631f4..0000000000 --- a/api/source_en/api/python/mindspore/mindspore.dataset.config.rst +++ /dev/null @@ -1,5 +0,0 @@ -mindspore.dataset.config -======================== - -.. automodule:: mindspore.dataset.config - :members: diff --git a/api/source_en/api/python/mindspore/mindspore.dataset.rst b/api/source_en/api/python/mindspore/mindspore.dataset.rst index c5e1cdf7d3..1437a22b8e 100644 --- a/api/source_en/api/python/mindspore/mindspore.dataset.rst +++ b/api/source_en/api/python/mindspore/mindspore.dataset.rst @@ -5,3 +5,10 @@ mindspore.dataset :members: :inherited-members: :exclude-members: get_args, read_dir + +mindspore.dataset.config +------------------------ + +.. automodule:: mindspore.dataset.config + :members: + \ No newline at end of file diff --git a/api/source_en/api/python/mindspore/mindspore.dtype.rst b/api/source_en/api/python/mindspore/mindspore.dtype.rst deleted file mode 100644 index ecedea9718..0000000000 --- a/api/source_en/api/python/mindspore/mindspore.dtype.rst +++ /dev/null @@ -1,111 +0,0 @@ -mindspore.dtype -=============== - -Data Type ----------- - -.. class:: mindspore.dtype - -Create a data type object of MindSpore. - -The actual path of ``dtype`` is ``/mindspore/common/dtype.py``. -Run the following command to import the package: - -.. code-block:: - - import mindspore.common.dtype as mstype - -or - -.. code-block:: - - from mindspore import dtype as mstype - -Numeric Type -~~~~~~~~~~~~ - -Currently, MindSpore supports ``Int`` type, ``Uint`` type and ``Float`` type. -The following table lists the details. - -============================================== ============================= -Definition Description -============================================== ============================= -``mindspore.int8`` , ``mindspore.byte`` 8-bit integer -``mindspore.int16`` , ``mindspore.short`` 16-bit integer -``mindspore.int32`` , ``mindspore.intc`` 32-bit integer -``mindspore.int64`` , ``mindspore.intp`` 64-bit integer -``mindspore.uint8`` , ``mindspore.ubyte`` unsigned 8-bit integer -``mindspore.uint16`` , ``mindspore.ushort`` unsigned 16-bit integer -``mindspore.uint32`` , ``mindspore.uintc`` unsigned 32-bit integer -``mindspore.uint64`` , ``mindspore.uintp`` unsigned 64-bit integer -``mindspore.float16`` , ``mindspore.half`` 16-bit floating-point number -``mindspore.float32`` , ``mindspore.single`` 32-bit floating-point number -``mindspore.float64`` , ``mindspore.double`` 64-bit floating-point number -============================================== ============================= - -Other Type -~~~~~~~~~~ - -For other defined types, see the following table. - -============================ ================= -Type Description -============================ ================= -``tensor`` MindSpore's ``tensor`` type. Data format uses NCHW. For details, see [tensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/tensor.py). -``MetaTensor`` A tensor only has data type and shape. For details, see [MetaTensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/parameter.py). -``bool_`` Boolean ``True`` or ``False``. -``int_`` Integer scalar. -``uint`` Unsigned integer scalar. -``float_`` Floating-point scalar. -``number`` Number, including ``int_`` , ``uint`` , ``float_`` and ``bool_`` . -``list_`` List constructed by ``tensor`` , such as ``List[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. -``tuple_`` Tuple constructed by ``tensor`` , such as ``Tuple[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. -``function`` Function. Return in two ways, when function is not None, returns Func directly, the other returns Func(args: List[T0,T1,...,Tn], retval: T) when function is None. -``type_type`` Type definition of type. -``type_none`` No matching return type, corresponding to the ``type(None)`` in Python. -``symbolic_key`` The value of a variable is used as a key of the variable in ``env_type`` . -``env_type`` Used to store the gradient of the free variable of a function, where the key is the ``symbolic_key`` of the free variable's node and the value is the gradient. -============================ ================= - -Tree Topology -~~~~~~~~~~~~~~ - -The relationships of the above types are as follows: - -.. 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 - ├─── tensor - │ ├─── Array[Float32] - │ └─── ... - ├─── list_ - │ ├─── List[Int32,Float32] - │ └─── ... - ├─── tuple_ - │ ├─── Tuple[Int32,Float32] - │ └─── ... - ├─── function - │ ├─── Func - │ ├─── Func[(Int32, Float32), Int32] - │ └─── ... - ├─── MetaTensor - ├─── type_type - ├─── type_none - ├─── symbolic_key - └─── env_type \ No newline at end of file diff --git a/api/source_en/api/python/mindspore/mindspore.ops.composite.rst b/api/source_en/api/python/mindspore/mindspore.ops.composite.rst deleted file mode 100644 index 4dc22f1dcf..0000000000 --- a/api/source_en/api/python/mindspore/mindspore.ops.composite.rst +++ /dev/null @@ -1,5 +0,0 @@ -mindspore.ops.composite -======================= - -.. automodule:: mindspore.ops.composite - :members: diff --git a/api/source_en/api/python/mindspore/mindspore.ops.operations.rst b/api/source_en/api/python/mindspore/mindspore.ops.operations.rst deleted file mode 100644 index 29bf49176b..0000000000 --- a/api/source_en/api/python/mindspore/mindspore.ops.operations.rst +++ /dev/null @@ -1,5 +0,0 @@ -mindspore.ops.operations -======================== - -.. automodule:: mindspore.ops.operations - :members: diff --git a/api/source_en/api/python/mindspore/mindspore.parallel.rst b/api/source_en/api/python/mindspore/mindspore.parallel.rst new file mode 100644 index 0000000000..01b50521e2 --- /dev/null +++ b/api/source_en/api/python/mindspore/mindspore.parallel.rst @@ -0,0 +1,5 @@ +mindspore.parallel +============= + +.. automodule:: mindspore.parallel + :members: \ No newline at end of file diff --git a/api/source_en/api/python/mindspore/mindspore.rst b/api/source_en/api/python/mindspore/mindspore.rst index 44c49e3df3..118c3a9c04 100644 --- a/api/source_en/api/python/mindspore/mindspore.rst +++ b/api/source_en/api/python/mindspore/mindspore.rst @@ -1,5 +1,118 @@ mindspore ========= +mindspore.dtype +--------------- + +Data Type +~~~~~~~~~ + +.. class:: mindspore.dtype + +Create a data type object of MindSpore. + +The actual path of ``dtype`` is ``/mindspore/common/dtype.py``. +Run the following command to import the package: + +.. code-block:: + + import mindspore.common.dtype as mstype + +or + +.. code-block:: + + from mindspore import dtype as mstype + +Numeric Type +++++++++++++ + +Currently, MindSpore supports ``Int`` type, ``Uint`` type and ``Float`` type. +The following table lists the details. + +============================================== ============================= +Definition Description +============================================== ============================= +``mindspore.int8`` , ``mindspore.byte`` 8-bit integer +``mindspore.int16`` , ``mindspore.short`` 16-bit integer +``mindspore.int32`` , ``mindspore.intc`` 32-bit integer +``mindspore.int64`` , ``mindspore.intp`` 64-bit integer +``mindspore.uint8`` , ``mindspore.ubyte`` unsigned 8-bit integer +``mindspore.uint16`` , ``mindspore.ushort`` unsigned 16-bit integer +``mindspore.uint32`` , ``mindspore.uintc`` unsigned 32-bit integer +``mindspore.uint64`` , ``mindspore.uintp`` unsigned 64-bit integer +``mindspore.float16`` , ``mindspore.half`` 16-bit floating-point number +``mindspore.float32`` , ``mindspore.single`` 32-bit floating-point number +``mindspore.float64`` , ``mindspore.double`` 64-bit floating-point number +============================================== ============================= + +Other Type +++++++++++ + +For other defined types, see the following table. + +============================ ================= +Type Description +============================ ================= +``tensor`` MindSpore's ``tensor`` type. Data format uses NCHW. For details, see [tensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/tensor.py). +``MetaTensor`` A tensor only has data type and shape. For details, see [MetaTensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/parameter.py). +``bool_`` Boolean ``True`` or ``False``. +``int_`` Integer scalar. +``uint`` Unsigned integer scalar. +``float_`` Floating-point scalar. +``number`` Number, including ``int_`` , ``uint`` , ``float_`` and ``bool_`` . +``list_`` List constructed by ``tensor`` , such as ``List[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. +``tuple_`` Tuple constructed by ``tensor`` , such as ``Tuple[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. +``function`` Function. Return in two ways, when function is not None, returns Func directly, the other returns Func(args: List[T0,T1,...,Tn], retval: T) when function is None. +``type_type`` Type definition of type. +``type_none`` No matching return type, corresponding to the ``type(None)`` in Python. +``symbolic_key`` The value of a variable is used as a key of the variable in ``env_type`` . +``env_type`` Used to store the gradient of the free variable of a function, where the key is the ``symbolic_key`` of the free variable's node and the value is the gradient. +============================ ================= + +Tree Topology ++++++++++++++ + +The relationships of the above types are as follows: + +.. 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 + ├─── tensor + │ ├─── Array[Float32] + │ └─── ... + ├─── list_ + │ ├─── List[Int32,Float32] + │ └─── ... + ├─── tuple_ + │ ├─── Tuple[Int32,Float32] + │ └─── ... + ├─── function + │ ├─── Func + │ ├─── Func[(Int32, Float32), Int32] + │ └─── ... + ├─── MetaTensor + ├─── type_type + ├─── type_none + ├─── symbolic_key + └─── env_type + .. automodule:: mindspore - :members: \ No newline at end of file + :members: + :exclude-members: Model, dataset_helper, \ No newline at end of file diff --git a/api/source_en/api/python/mindspore/mindspore.train.rst b/api/source_en/api/python/mindspore/mindspore.train.rst index eb6753e672..a07fa6b359 100644 --- a/api/source_en/api/python/mindspore/mindspore.train.rst +++ b/api/source_en/api/python/mindspore/mindspore.train.rst @@ -1,6 +1,9 @@ mindspore.train =============== +.. automodule:: mindspore.train + :members: + mindspore.train.summary ----------------------- @@ -19,11 +22,6 @@ mindspore.train.serialization .. automodule:: mindspore.train.serialization :members: -mindspore.train.amp -------------------- - -.. automodule:: mindspore.train.amp - :members: mindspore.train.loss_scale_manager ---------------------------------- diff --git a/api/source_en/index.rst b/api/source_en/index.rst index ebaf340a02..c9156af315 100644 --- a/api/source_en/index.rst +++ b/api/source_en/index.rst @@ -11,25 +11,23 @@ MindSpore API :caption: MindSpore Python API api/python/mindspore/mindspore - api/python/mindspore/mindspore.dtype api/python/mindspore/mindspore.common.initializer api/python/mindspore/mindspore.communication api/python/mindspore/mindspore.context - api/python/mindspore/mindspore.nn - api/python/mindspore/mindspore.nn.dynamic_lr - api/python/mindspore/mindspore.nn.learning_rate_schedule - api/python/mindspore/mindspore.nn.probability - api/python/mindspore/mindspore.ops - api/python/mindspore/mindspore.ops.composite - api/python/mindspore/mindspore.ops.operations - api/python/mindspore/mindspore.train api/python/mindspore/mindspore.dataset api/python/mindspore/mindspore.dataset.config api/python/mindspore/mindspore.dataset.text api/python/mindspore/mindspore.dataset.transforms api/python/mindspore/mindspore.dataset.vision api/python/mindspore/mindspore.mindrecord + api/python/mindspore/mindspore.nn + api/python/mindspore/mindspore.nn.dynamic_lr + api/python/mindspore/mindspore.nn.probability + api/python/mindspore/mindspore.ops + api/python/mindspore/mindspore.parallel api/python/mindspore/mindspore.profiler + api/python/mindspore/mindspore.train + .. toctree:: :maxdepth: 1 diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.dataset.config.rst b/api/source_zh_cn/api/python/mindspore/mindspore.dataset.config.rst deleted file mode 100644 index 55cf3631f4..0000000000 --- a/api/source_zh_cn/api/python/mindspore/mindspore.dataset.config.rst +++ /dev/null @@ -1,5 +0,0 @@ -mindspore.dataset.config -======================== - -.. automodule:: mindspore.dataset.config - :members: diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.dtype.rst b/api/source_zh_cn/api/python/mindspore/mindspore.dtype.rst deleted file mode 100644 index 633cd1e23e..0000000000 --- a/api/source_zh_cn/api/python/mindspore/mindspore.dtype.rst +++ /dev/null @@ -1,112 +0,0 @@ -mindspore.dtype -=============== - -Data Type ----------- - -.. class:: mindspore.dtype - -Create a data type object of MindSpore. - -The actual path of ``dtype`` is ``/mindspore/common/dtype.py``. -Run the following command to import the package: - -.. code-block:: - - import mindspore.common.dtype as mstype - -or - -.. code-block:: - - from mindspore import dtype as mstype - -Numeric Type -~~~~~~~~~~~~ - -Currently, MindSpore supports ``Int`` type, ``Uint`` type and ``Float`` type. -The following table lists the details. - -============================================== ============================= -Definition Description -============================================== ============================= -``mindspore.int8`` , ``mindspore.byte`` 8-bit integer -``mindspore.int16`` , ``mindspore.short`` 16-bit integer -``mindspore.int32`` , ``mindspore.intc`` 32-bit integer -``mindspore.int64`` , ``mindspore.intp`` 64-bit integer -``mindspore.uint8`` , ``mindspore.ubyte`` unsigned 8-bit integer -``mindspore.uint16`` , ``mindspore.ushort`` unsigned 16-bit integer -``mindspore.uint32`` , ``mindspore.uintc`` unsigned 32-bit integer -``mindspore.uint64`` , ``mindspore.uintp`` unsigned 64-bit integer -``mindspore.float16`` , ``mindspore.half`` 16-bit floating-point number -``mindspore.float32`` , ``mindspore.single`` 32-bit floating-point number -``mindspore.float64`` , ``mindspore.double`` 64-bit floating-point number -============================================== ============================= - -Other Type -~~~~~~~~~~ - -For other defined types, see the following table. - -============================ ================= -Type Description -============================ ================= -``tensor`` MindSpore's ``tensor`` type. Data format uses NCHW. For details, see [tensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/tensor.py). -``MetaTensor`` A tensor only has data type and shape. For details, see [MetaTensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/parameter.py). -``bool_`` Boolean ``True`` or ``False``. -``int_`` Integer scalar. -``uint`` Unsigned integer scalar. -``float_`` Floating-point scalar. -``number`` Number, including ``int_`` , ``uint`` , ``float_`` and ``bool_`` . -``list_`` List constructed by ``tensor`` , such as ``List[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. -``tuple_`` Tuple constructed by ``tensor`` , such as ``Tuple[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. -``function`` Function. Return in two ways, when function is not None, returns Func directly, the other returns Func(args: List[T0,T1,...,Tn], retval: T) when function is None. -``type_type`` Type definition of type. -``type_none`` No matching return type, corresponding to the ``type(None)`` in Python. -``symbolic_key`` The value of a variable is used as a key of the variable in ``env_type`` . -``env_type`` Used to store the gradient of the free variable of a function, where the key is the ``symbolic_key`` of the free variable's node and the value is the gradient. -============================ ================= - -Tree Topology -~~~~~~~~~~~~~~ - -The relationships of the above types are as follows: - -.. code-block:: - - - └─── mindspore.dtype - ├─── number - │ ├─── bool_ - │ ├─── int_ - │ │ ├─── int8, byte - │ │ ├─── int16, short - │ │ ├─── int32, intc - │ │ └─── int64, intp - │ ├─── uint - │ │ ├─── uint8, ubyte - │ │ ├─── uint16, ushort - │ │ ├─── uint32, uintc - │ │ └─── uint64, uintp - │ └─── float_ - │ ├─── float16 - │ ├─── float32 - │ └─── float64 - ├─── tensor - │ ├─── Array[float32] - │ └─── ... - ├─── list_ - │ ├─── List[int32,float32] - │ └─── ... - ├─── tuple_ - │ ├─── Tuple[int32,float32] - │ └─── ... - ├─── function - │ ├─── Func - │ ├─── Func[(int32, float32), int32] - │ └─── ... - ├─── MetaTensor - ├─── type_type - ├─── type_none - ├─── symbolic_key - └─── env_type \ No newline at end of file diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.ops.composite.rst b/api/source_zh_cn/api/python/mindspore/mindspore.ops.composite.rst deleted file mode 100644 index 4dc22f1dcf..0000000000 --- a/api/source_zh_cn/api/python/mindspore/mindspore.ops.composite.rst +++ /dev/null @@ -1,5 +0,0 @@ -mindspore.ops.composite -======================= - -.. automodule:: mindspore.ops.composite - :members: diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.ops.operations.rst b/api/source_zh_cn/api/python/mindspore/mindspore.ops.operations.rst deleted file mode 100644 index 29bf49176b..0000000000 --- a/api/source_zh_cn/api/python/mindspore/mindspore.ops.operations.rst +++ /dev/null @@ -1,5 +0,0 @@ -mindspore.ops.operations -======================== - -.. automodule:: mindspore.ops.operations - :members: diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.parallel.rst b/api/source_zh_cn/api/python/mindspore/mindspore.parallel.rst new file mode 100644 index 0000000000..01b50521e2 --- /dev/null +++ b/api/source_zh_cn/api/python/mindspore/mindspore.parallel.rst @@ -0,0 +1,5 @@ +mindspore.parallel +============= + +.. automodule:: mindspore.parallel + :members: \ No newline at end of file diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.rst b/api/source_zh_cn/api/python/mindspore/mindspore.rst index 44c49e3df3..118c3a9c04 100644 --- a/api/source_zh_cn/api/python/mindspore/mindspore.rst +++ b/api/source_zh_cn/api/python/mindspore/mindspore.rst @@ -1,5 +1,118 @@ mindspore ========= +mindspore.dtype +--------------- + +Data Type +~~~~~~~~~ + +.. class:: mindspore.dtype + +Create a data type object of MindSpore. + +The actual path of ``dtype`` is ``/mindspore/common/dtype.py``. +Run the following command to import the package: + +.. code-block:: + + import mindspore.common.dtype as mstype + +or + +.. code-block:: + + from mindspore import dtype as mstype + +Numeric Type +++++++++++++ + +Currently, MindSpore supports ``Int`` type, ``Uint`` type and ``Float`` type. +The following table lists the details. + +============================================== ============================= +Definition Description +============================================== ============================= +``mindspore.int8`` , ``mindspore.byte`` 8-bit integer +``mindspore.int16`` , ``mindspore.short`` 16-bit integer +``mindspore.int32`` , ``mindspore.intc`` 32-bit integer +``mindspore.int64`` , ``mindspore.intp`` 64-bit integer +``mindspore.uint8`` , ``mindspore.ubyte`` unsigned 8-bit integer +``mindspore.uint16`` , ``mindspore.ushort`` unsigned 16-bit integer +``mindspore.uint32`` , ``mindspore.uintc`` unsigned 32-bit integer +``mindspore.uint64`` , ``mindspore.uintp`` unsigned 64-bit integer +``mindspore.float16`` , ``mindspore.half`` 16-bit floating-point number +``mindspore.float32`` , ``mindspore.single`` 32-bit floating-point number +``mindspore.float64`` , ``mindspore.double`` 64-bit floating-point number +============================================== ============================= + +Other Type +++++++++++ + +For other defined types, see the following table. + +============================ ================= +Type Description +============================ ================= +``tensor`` MindSpore's ``tensor`` type. Data format uses NCHW. For details, see [tensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/tensor.py). +``MetaTensor`` A tensor only has data type and shape. For details, see [MetaTensor](https://www.gitee.com/mindspore/mindspore/blob/master/mindspore/common/parameter.py). +``bool_`` Boolean ``True`` or ``False``. +``int_`` Integer scalar. +``uint`` Unsigned integer scalar. +``float_`` Floating-point scalar. +``number`` Number, including ``int_`` , ``uint`` , ``float_`` and ``bool_`` . +``list_`` List constructed by ``tensor`` , such as ``List[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. +``tuple_`` Tuple constructed by ``tensor`` , such as ``Tuple[T0,T1,...,Tn]`` , where the element ``Ti`` can be of different types. +``function`` Function. Return in two ways, when function is not None, returns Func directly, the other returns Func(args: List[T0,T1,...,Tn], retval: T) when function is None. +``type_type`` Type definition of type. +``type_none`` No matching return type, corresponding to the ``type(None)`` in Python. +``symbolic_key`` The value of a variable is used as a key of the variable in ``env_type`` . +``env_type`` Used to store the gradient of the free variable of a function, where the key is the ``symbolic_key`` of the free variable's node and the value is the gradient. +============================ ================= + +Tree Topology ++++++++++++++ + +The relationships of the above types are as follows: + +.. 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 + ├─── tensor + │ ├─── Array[Float32] + │ └─── ... + ├─── list_ + │ ├─── List[Int32,Float32] + │ └─── ... + ├─── tuple_ + │ ├─── Tuple[Int32,Float32] + │ └─── ... + ├─── function + │ ├─── Func + │ ├─── Func[(Int32, Float32), Int32] + │ └─── ... + ├─── MetaTensor + ├─── type_type + ├─── type_none + ├─── symbolic_key + └─── env_type + .. automodule:: mindspore - :members: \ No newline at end of file + :members: + :exclude-members: Model, dataset_helper, \ No newline at end of file diff --git a/api/source_zh_cn/api/python/mindspore/mindspore.train.rst b/api/source_zh_cn/api/python/mindspore/mindspore.train.rst index eb6753e672..a07fa6b359 100644 --- a/api/source_zh_cn/api/python/mindspore/mindspore.train.rst +++ b/api/source_zh_cn/api/python/mindspore/mindspore.train.rst @@ -1,6 +1,9 @@ mindspore.train =============== +.. automodule:: mindspore.train + :members: + mindspore.train.summary ----------------------- @@ -19,11 +22,6 @@ mindspore.train.serialization .. automodule:: mindspore.train.serialization :members: -mindspore.train.amp -------------------- - -.. automodule:: mindspore.train.amp - :members: mindspore.train.loss_scale_manager ---------------------------------- diff --git a/api/source_zh_cn/index.rst b/api/source_zh_cn/index.rst index 871c4d0f6a..77edffec06 100644 --- a/api/source_zh_cn/index.rst +++ b/api/source_zh_cn/index.rst @@ -19,25 +19,22 @@ MindSpore API :caption: MindSpore Python API api/python/mindspore/mindspore - api/python/mindspore/mindspore.dtype api/python/mindspore/mindspore.common.initializer api/python/mindspore/mindspore.communication api/python/mindspore/mindspore.context - api/python/mindspore/mindspore.nn - api/python/mindspore/mindspore.nn.dynamic_lr - api/python/mindspore/mindspore.nn.learning_rate_schedule - api/python/mindspore/mindspore.nn.probability - api/python/mindspore/mindspore.ops - api/python/mindspore/mindspore.ops.composite - api/python/mindspore/mindspore.ops.operations - api/python/mindspore/mindspore.train api/python/mindspore/mindspore.dataset api/python/mindspore/mindspore.dataset.config api/python/mindspore/mindspore.dataset.text api/python/mindspore/mindspore.dataset.transforms api/python/mindspore/mindspore.dataset.vision api/python/mindspore/mindspore.mindrecord + api/python/mindspore/mindspore.nn + api/python/mindspore/mindspore.nn.dynamic_lr + api/python/mindspore/mindspore.nn.probability + api/python/mindspore/mindspore.ops + api/python/mindspore/mindspore.parallel api/python/mindspore/mindspore.profiler + api/python/mindspore/mindspore.train .. toctree:: :maxdepth: 1 diff --git a/tutorials/source_zh_cn/_static/logo_online_experience.png b/tutorials/source_zh_cn/_static/logo_online_experience.png new file mode 100644 index 0000000000000000000000000000000000000000..c630af6e0c580998357c4865f25f459e9508333c GIT binary patch literal 1991 zcmV;&2RQhNP)H00009a7bBm000XT z000XT0n*)m`~Uz4c}YY;RA_#sFF z>i_GF9;?;x(Gd<6e$Z%)i19zG)zH~9hIU@Nz zOb90AnV9idG|rV%l$cbmvnrg){^!huGg-s?25nS@JlNZvCIvNMx4mGs4&RJZ6m`*N zoAhRVXV%vBcU&|*?Qzd~`wr^DzRv91Z@Fmt0Fps5Nm10o;J|?mcya{AWK1e& z-+l{%Ik4XWtmT%slF-V^TRNCVec+bM}L| z!E^S7!GXud^)O)CD1d zw|Z#nXh-``+S?Q5yUyk7i@Chn$bj9J;72C9yCy#Vq+*ij7=&Cj4ZmrRn?Wd2C{PqN zmr4t=tck%TCS+!9J*Oyhsr1a+`dlhqrwtPVVn9$%QG#M}W^LUpBbgzb$?AvbFJbDL zwe_Hwgj5+6lbWgFOjffBtc9$rjfxbC@Klg73=e0rn2?3R0Uyg!6y;-CNE@1@o&-=5 zlgfHp>R8eX&!y5$O3Z#}18Ra5-yB`MaQ=f=hi(jC+#VnM_1QD;-ntzvm735rf9~a0 zgy!#j`GmB>o(pHPf{gX#3NproXldL<(~T)zkTEbN$QXQsr4tmBPZeE3mi3frms2aN zkwVc$(>|8XDazE!r|?wcTE7UwnQTldGYCzsti~h>mTyo@LhJ=u2FXaFIO*tSbT0!K zgf>PmPkY>YlQbou5R@3Q1j6A=)bll+ z*J46qQhCudf#GCb?;n{;&RiyY5!F-eL^WuCM1oL!JHWMi#$SQs3DAB0dJr%8uHkgt)sAeh07F#fQfZ#EPkY?j%Zh1_JDka? zG9EY}%zFD^TQ{=Ab9NugsApMDt#pzZH!Y!1=tn0{&fob`tW-wZ+fTH#7|QjXJjtCn z@wZ*+7cai}-f1t0ZC9&5UHz1^ocO)Tdw{XdPRk>O9Ttm^WmmuY%HP(;bKL!}zfRq| zw_B@$8~(N*c33Q!5d9GKew(3A{iEI5eNf(HcD)!hqAx3xjr_2JIHEG;cpoX+3& z{}{%q{&u)%`iiq>w|4(e`TTCJcE#!ZW$#Nc(2%9E&d$`mf5XZE$vRH~`|prNj03TF zD?)~^Db$x!t*rTFAE5*Sv!4%Lj{8`KTYudh4V*oeJ(&z Z)HjqDSD~6lCIkQg002ovPDHLkV1f|c?x+9& literal 0 HcmV?d00001 diff --git a/tutorials/source_zh_cn/quick_start/quick_start.md b/tutorials/source_zh_cn/quick_start/quick_start.md index 0a2b025632..5b9049a695 100644 --- a/tutorials/source_zh_cn/quick_start/quick_start.md +++ b/tutorials/source_zh_cn/quick_start/quick_start.md @@ -2,6 +2,12 @@ `Linux` `Windows` `Ascend` `GPU` `CPU` `全流程` `初级` `中级` `高级` + +   + +   + + - [实现一个图片分类应用](#实现一个图片分类应用) @@ -25,10 +31,6 @@ - -   - - ## 概述 下面我们通过一个实际样例，带领大家体验MindSpore基础的功能，对于一般的用户而言，完成整个样例实践会持续20~30分钟。 -- Gitee