forked from mindspore-Ecosystem/mindspore
!27215 modify index pages for chinese python API.
Merge pull request !27215 from zhangyi/code_docs_master
This commit is contained in:
commit
fe5a3ba2cc
|
@ -7,9 +7,13 @@ Vision
|
||||||
.. cnmsautosummary::
|
.. cnmsautosummary::
|
||||||
:toctree: dataset
|
:toctree: dataset
|
||||||
|
|
||||||
|
mindspore.dataset.CelebADataset
|
||||||
|
mindspore.dataset.CocoDataset
|
||||||
mindspore.dataset.ImageFolderDataset
|
mindspore.dataset.ImageFolderDataset
|
||||||
mindspore.dataset.MnistDataset
|
mindspore.dataset.MnistDataset
|
||||||
mindspore.dataset.VOCDataset
|
mindspore.dataset.VOCDataset
|
||||||
|
mindspore.dataset.Cifar100Dataset
|
||||||
|
mindspore.dataset.Cifar10Dataset
|
||||||
|
|
||||||
Text
|
Text
|
||||||
----
|
----
|
||||||
|
@ -34,6 +38,7 @@ User Defined
|
||||||
.. cnmsautosummary::
|
.. cnmsautosummary::
|
||||||
:toctree: dataset
|
:toctree: dataset
|
||||||
|
|
||||||
|
mindspore.dataset.GeneratorDataset
|
||||||
mindspore.dataset.NumpySlicesDataset
|
mindspore.dataset.NumpySlicesDataset
|
||||||
mindspore.dataset.PaddedDataset
|
mindspore.dataset.PaddedDataset
|
||||||
|
|
||||||
|
@ -51,19 +56,31 @@ Sampler
|
||||||
mindspore.dataset.SubsetSampler
|
mindspore.dataset.SubsetSampler
|
||||||
mindspore.dataset.WeightedRandomSampler
|
mindspore.dataset.WeightedRandomSampler
|
||||||
|
|
||||||
|
Standard Format
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. cnmsautosummary::
|
||||||
|
:toctree: dataset
|
||||||
|
|
||||||
|
mindspore.dataset.CSVDataset
|
||||||
|
mindspore.dataset.ManifestDataset
|
||||||
|
mindspore.dataset.MindDataset
|
||||||
|
mindspore.dataset.TFRecordDataset
|
||||||
|
mindspore.dataset.TextFileDataset
|
||||||
|
|
||||||
Others
|
Others
|
||||||
------
|
------
|
||||||
|
|
||||||
.. cnmsautosummary::
|
.. cnmsautosummary::
|
||||||
:toctree: dataset
|
:toctree: dataset
|
||||||
|
|
||||||
mindspore.dataset.compare
|
|
||||||
mindspore.dataset.DatasetCache
|
|
||||||
mindspore.dataset.deserialize
|
|
||||||
mindspore.dataset.DSCallback
|
mindspore.dataset.DSCallback
|
||||||
|
mindspore.dataset.DatasetCache
|
||||||
mindspore.dataset.Schema
|
mindspore.dataset.Schema
|
||||||
|
mindspore.dataset.WaitedDSCallback
|
||||||
|
mindspore.dataset.compare
|
||||||
|
mindspore.dataset.deserialize
|
||||||
mindspore.dataset.serialize
|
mindspore.dataset.serialize
|
||||||
mindspore.dataset.show
|
mindspore.dataset.show
|
||||||
mindspore.dataset.utils.imshow_det_bbox
|
mindspore.dataset.utils.imshow_det_bbox
|
||||||
mindspore.dataset.WaitedDSCallback
|
|
||||||
mindspore.dataset.zip
|
mindspore.dataset.zip
|
||||||
|
|
|
@ -11,7 +11,6 @@ Bijectors
|
||||||
.. cnmsplatformautosummary::
|
.. cnmsplatformautosummary::
|
||||||
:toctree: nn_probability
|
:toctree: nn_probability
|
||||||
|
|
||||||
mindspore.nn.Metric
|
|
||||||
mindspore.nn.probability.bijector.Bijector
|
mindspore.nn.probability.bijector.Bijector
|
||||||
mindspore.nn.probability.bijector.Exp
|
mindspore.nn.probability.bijector.Exp
|
||||||
mindspore.nn.probability.bijector.GumbelCDF
|
mindspore.nn.probability.bijector.GumbelCDF
|
||||||
|
|
|
@ -12,11 +12,28 @@ Cell
|
||||||
Dynamic Learning Rate
|
Dynamic Learning Rate
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: nn
|
||||||
|
|
||||||
|
mindspore.nn.cosine_decay_lr
|
||||||
|
mindspore.nn.exponential_decay_lr
|
||||||
|
mindspore.nn.inverse_decay_lr
|
||||||
|
mindspore.nn.natural_exp_decay_lr
|
||||||
|
mindspore.nn.piecewise_constant_lr
|
||||||
|
mindspore.nn.polynomial_decay_lr
|
||||||
|
mindspore.nn.warmup_lr
|
||||||
|
|
||||||
|
Dynamic Learning Rate
|
||||||
|
---------------------
|
||||||
|
|
||||||
.. cnmsplatformautosummary::
|
.. cnmsplatformautosummary::
|
||||||
:toctree: nn
|
:toctree: nn
|
||||||
|
|
||||||
mindspore.nn.CosineDecayLR
|
mindspore.nn.CosineDecayLR
|
||||||
mindspore.nn.ExponentialDecayLR
|
mindspore.nn.ExponentialDecayLR
|
||||||
|
mindspore.nn.InverseDecayLR
|
||||||
|
mindspore.nn.NaturalExpDecayLR
|
||||||
|
mindspore.nn.PolynomialDecayLR
|
||||||
mindspore.nn.WarmUpLR
|
mindspore.nn.WarmUpLR
|
||||||
|
|
||||||
Gradient
|
Gradient
|
||||||
|
@ -34,8 +51,31 @@ Metrics
|
||||||
.. cnmsplatformautosummary::
|
.. cnmsplatformautosummary::
|
||||||
:toctree: nn
|
:toctree: nn
|
||||||
|
|
||||||
|
mindspore.nn.Fbeta
|
||||||
|
mindspore.nn.Loss
|
||||||
|
mindspore.nn.MAE
|
||||||
|
mindspore.nn.MSE
|
||||||
mindspore.nn.Metric
|
mindspore.nn.Metric
|
||||||
|
mindspore.nn.Precision
|
||||||
|
mindspore.nn.Recall
|
||||||
|
mindspore.nn.Top1CategoricalAccuracy
|
||||||
|
mindspore.nn.Top5CategoricalAccuracy
|
||||||
|
mindspore.nn.TopKCategoricalAccuracy
|
||||||
|
mindspore.nn.get_metric_fn
|
||||||
|
mindspore.nn.names
|
||||||
|
mindspore.nn.rearrange_inputs
|
||||||
|
|
||||||
|
Non-linear Activations
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: nn
|
||||||
|
|
||||||
|
mindspore.nn.FastGelu
|
||||||
|
mindspore.nn.HSwish
|
||||||
|
mindspore.nn.ReLU
|
||||||
|
mindspore.nn.elu
|
||||||
|
mindspore.nn.gelu
|
||||||
|
|
||||||
Optimizer Functions
|
Optimizer Functions
|
||||||
-------------------
|
-------------------
|
||||||
|
@ -45,5 +85,28 @@ Optimizer Functions
|
||||||
|
|
||||||
mindspore.nn.Adagrad
|
mindspore.nn.Adagrad
|
||||||
mindspore.nn.Adam
|
mindspore.nn.Adam
|
||||||
|
mindspore.nn.AdamOffload
|
||||||
|
mindspore.nn.AdamWeightDecay
|
||||||
|
mindspore.nn.FTRL
|
||||||
|
mindspore.nn.LARS
|
||||||
|
mindspore.nn.Lamb
|
||||||
|
mindspore.nn.LazyAdam
|
||||||
mindspore.nn.Momentum
|
mindspore.nn.Momentum
|
||||||
mindspore.nn.Optimizer
|
mindspore.nn.Optimizer
|
||||||
|
mindspore.nn.ProximalAdagrad
|
||||||
|
mindspore.nn.RMSProp
|
||||||
|
mindspore.nn.SGD
|
||||||
|
|
||||||
|
Wrapper Functions
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: nn
|
||||||
|
|
||||||
|
mindspore.nn.DynamicLossScaleUpdateCell
|
||||||
|
mindspore.nn.FixedLossScaleUpdateCell
|
||||||
|
mindspore.nn.ForwardValueAndGrad
|
||||||
|
mindspore.nn.TrainOneStepCell
|
||||||
|
mindspore.nn.TrainOneStepWithLossScaleCell
|
||||||
|
mindspore.nn.WithEvalCell
|
||||||
|
mindspore.nn.WithLossCell
|
||||||
|
|
|
@ -0,0 +1,58 @@
|
||||||
|
mindspore.ops
|
||||||
|
=============
|
||||||
|
|
||||||
|
operations
|
||||||
|
----------
|
||||||
|
|
||||||
|
Neural Network Operators
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: ops
|
||||||
|
|
||||||
|
mindspore.ops.GeLU
|
||||||
|
mindspore.ops.L2Loss
|
||||||
|
mindspore.ops.PReLU
|
||||||
|
mindspore.ops.ReLUV2
|
||||||
|
mindspore.ops.SeLU
|
||||||
|
mindspore.ops.Sigmoid
|
||||||
|
|
||||||
|
Array Operators
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: ops
|
||||||
|
|
||||||
|
mindspore.ops.OnesLike
|
||||||
|
mindspore.ops.Reshape
|
||||||
|
mindspore.ops.Size
|
||||||
|
mindspore.ops.Tile
|
||||||
|
mindspore.ops.ZerosLike
|
||||||
|
|
||||||
|
Math Operators
|
||||||
|
--------------
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: ops
|
||||||
|
|
||||||
|
mindspore.ops.Add
|
||||||
|
mindspore.ops.AddN
|
||||||
|
mindspore.ops.Div
|
||||||
|
mindspore.ops.Eps
|
||||||
|
mindspore.ops.Erf
|
||||||
|
mindspore.ops.LessEqual
|
||||||
|
mindspore.ops.Log
|
||||||
|
mindspore.ops.MatMul
|
||||||
|
mindspore.ops.Mul
|
||||||
|
mindspore.ops.Pow
|
||||||
|
mindspore.ops.Sub
|
||||||
|
|
||||||
|
|
||||||
|
Random Operators
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. cnmsplatformautosummary::
|
||||||
|
:toctree: ops
|
||||||
|
|
||||||
|
mindspore.ops.Gamma
|
||||||
|
mindspore.ops.UniformReal
|
|
@ -11,6 +11,26 @@ Tensor
|
||||||
mindspore.SparseTensor
|
mindspore.SparseTensor
|
||||||
mindspore.Tensor
|
mindspore.Tensor
|
||||||
|
|
||||||
|
DataType
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. cnmsautosummary::
|
||||||
|
:toctree: mindspore
|
||||||
|
|
||||||
|
mindspore.dtype_to_nptype
|
||||||
|
mindspore.dtype_to_pytype
|
||||||
|
mindspore.get_py_obj_dtype
|
||||||
|
mindspore.issubclass\_
|
||||||
|
mindspore.pytype_to_dtype
|
||||||
|
|
||||||
|
Installation Verification
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. cnmsautosummary::
|
||||||
|
:toctree: mindspore
|
||||||
|
|
||||||
|
indspore.run_check
|
||||||
|
|
||||||
Parameter
|
Parameter
|
||||||
---------
|
---------
|
||||||
|
|
||||||
|
@ -20,6 +40,15 @@ Parameter
|
||||||
mindspore.Parameter
|
mindspore.Parameter
|
||||||
mindspore.ParameterTuple
|
mindspore.ParameterTuple
|
||||||
|
|
||||||
|
Log
|
||||||
|
---
|
||||||
|
|
||||||
|
.. cnmsautosummary::
|
||||||
|
:toctree: mindspore
|
||||||
|
|
||||||
|
mindspore.get_level
|
||||||
|
mindspore.get_log_config
|
||||||
|
|
||||||
Model
|
Model
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -28,6 +57,15 @@ Model
|
||||||
|
|
||||||
mindspore.Model
|
mindspore.Model
|
||||||
|
|
||||||
|
Seed
|
||||||
|
----
|
||||||
|
|
||||||
|
.. cnmsautosummary::
|
||||||
|
:toctree: mindspore
|
||||||
|
|
||||||
|
mindspore.get_seed
|
||||||
|
mindspore.set_seed
|
||||||
|
|
||||||
Serialization
|
Serialization
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue