mindspore 2.0.0rc1__cp38-none-any.whl → 2.2.0__cp38-none-any.whl

mindspore/dataset/audio/utils.py

@@ -26,7 +26,8 @@ class BorderType(str, Enum):
     """
     Padding mode.
 
-    Possible enumeration values are: BorderType.CONSTANT, BorderType.EDGE, BorderType.REFLECT, BorderType.SYMMETRIC.
+    Possible enumeration values are: ``BorderType.CONSTANT``, ``BorderType.EDGE``, ``BorderType.REFLECT``,
+    ``BorderType.SYMMETRIC``.
 
     - BorderType.CONSTANT: Pad with a constant value.
     - BorderType.EDGE: Pad with the last value on the edge.
@@ -48,8 +49,8 @@ class DensityFunction(str, Enum):
     """
     Density function type.
 
-    Possible enumeration values are: DensityFunction.TPDF, DensityFunction.RPDF,
-    DensityFunction.GPDF.
+    Possible enumeration values are: ``DensityFunction.TPDF``, ``DensityFunction.RPDF``,
+    ``DensityFunction.GPDF``.
 
     - DensityFunction.TPDF: Triangular Probability Density Function.
     - DensityFunction.RPDF: Rectangular Probability Density Function.
@@ -64,8 +65,8 @@ class FadeShape(str, Enum):
     """
     Fade Shapes.
 
-    Possible enumeration values are: FadeShape.QUARTER_SINE, FadeShape.HALF_SINE, FadeShape.LINEAR,
-    FadeShape.LOGARITHMIC, FadeShape.EXPONENTIAL.
+    Possible enumeration values are: ``FadeShape.QUARTER_SINE``, ``FadeShape.HALF_SINE``, ``FadeShape.LINEAR``,
+    ``FadeShape.LOGARITHMIC``, ``FadeShape.EXPONENTIAL``.
 
     - FadeShape.QUARTER_SINE: means the fade shape is quarter_sine mode.
     - FadeShape.HALF_SINE: means the fade shape is half_sine mode.
@@ -84,7 +85,7 @@ class GainType(str, Enum):
     """
     Gain Types.
 
-    Possible enumeration values are: GainType.AMPLITUDE, GainType.POWER, GainType.DB.
+    Possible enumeration values are: ``GainType.AMPLITUDE``, ``GainType.POWER``, ``GainType.DB``.
 
     - GainType.AMPLITUDE: means input gain type is amplitude.
     - GainType.POWER: means input gain type is power.
@@ -99,7 +100,7 @@ class Interpolation(str, Enum):
     """
     Interpolation Type.
 
-    Possible enumeration values are: Interpolation.LINEAR, Interpolation.QUADRATIC.
+    Possible enumeration values are: ``Interpolation.LINEAR``, ``Interpolation.QUADRATIC``.
 
     - Interpolation.LINEAR: means input interpolation type is linear.
     - Interpolation.QUADRATIC: means input interpolation type is quadratic.
@@ -112,7 +113,7 @@ class MelType(str, Enum):
     """
     Mel scale implementation type.
 
-    Possible enumeration values are: MelType.HTK, MelType.SLANEY.
+    Possible enumeration values are: ``MelType.HTK``, ``MelType.SLANEY``.
 
     - MelType.HTK: The Hidden Markov Toolkit (HTK) implementation, refer to `HTK <https://htk.eng.cam.ac.uk/>`_ .
     - MelType.SLANEY: The MATLAB Auditory Toolbox of Slaney implementation,
@@ -139,7 +140,7 @@ class NormMode(str, Enum):
     """
     Normalization mode.
 
-    Possible enumeration values are: NormMode.ORTHO, NormMode.NONE.
+    Possible enumeration values are: ``NormMode.ORTHO``, ``NormMode.NONE``.
 
     - NormMode.ORTHO: Use an ortho-normal DCT basis.
     - NormMode.NONE: No normalization.
@@ -152,7 +153,7 @@ class NormType(str, Enum):
     """
     Normalization type.
 
-    Possible enumeration values are: NormType.SLANEY, NormType.NONE.
+    Possible enumeration values are: ``NormType.SLANEY``, ``NormType.NONE``.
 
     - NormType.SLANEY: Use an area normalization.
     - NormType.NONE: No narmalization.
@@ -165,7 +166,7 @@ class ResampleMethod(str, Enum):
     """
     Resample method.
 
-    Possible enumeration values are: ResampleMethod.SINC_INTERPOLATION, ResampleMethod.KAISER_WINDOW.
+    Possible enumeration values are: ``ResampleMethod.SINC_INTERPOLATION``, ``ResampleMethod.KAISER_WINDOW``.
 
     - ResampleMethod.SINC_INTERPOLATION: The Whittaker-Shannon interpolation or sinc interpolation formula.
     - ResampleMethod.KAISER_WINDOW: The Kaiser window interpolation.
@@ -178,7 +179,7 @@ class ScaleType(str, Enum):
     """
     Scale Types.
 
-    Possible enumeration values are: ScaleType.POWER, ScaleType.MAGNITUDE.
+    Possible enumeration values are: ``ScaleType.POWER``, ``ScaleType.MAGNITUDE``.
 
     - ScaleType.POWER: means the scale of input audio is power.
     - ScaleType.MAGNITUDE: means the scale of input audio is magnitude.
@@ -191,8 +192,8 @@ class WindowType(str, Enum):
     """
     Window function type.
 
-    Possible enumeration values are: WindowType.BARTLETT, WindowType.BLACKMAN, WindowType.HAMMING, WindowType.HANN,
-    WindowType.KAISER.
+    Possible enumeration values are: ``WindowType.BARTLETT``, ``WindowType.BLACKMAN``,
+    ``WindowType.HAMMING``, ``WindowType.HANN``, ``WindowType.KAISER``.
 
     - WindowType.BARTLETT: Bartlett window function.
     - WindowType.BLACKMAN: Blackman window function.
@@ -218,7 +219,8 @@ def create_dct(n_mfcc, n_mels, norm=NormMode.NONE):
     Args:
         n_mfcc (int): Number of mfc coefficients to retain, the value must be greater than 0.
         n_mels (int): Number of mel filterbanks, the value must be greater than 0.
-        norm (NormMode, optional): Normalization mode, can be NormMode.NONE or NormMode.ORTHO. Default: NormMode.NONE.
+        norm (NormMode, optional): Normalization mode, can be ``NormMode.NONE`` or ``NormMode.ORTHO``.
+            Default: ``NormMode.NONE``.
 
     Returns:
         numpy.ndarray, the transformation matrix, to be right-multiplied to row-wise data of size (n_mels, n_mfcc).
@@ -329,9 +331,10 @@ def melscale_fbanks(n_freqs, f_min, f_max, n_mels, sample_rate, norm=NormType.NO
         f_max (float): Maximum of frequency in Hz.
         n_mels (int): Number of mel filterbanks.
         sample_rate (int): Sample rate of the audio waveform.
-        norm (NormType, optional): Normalization method, can be NormType.NONE or NormType.SLANEY.
-            Default: NormType.NONE.
-        mel_type (MelType, optional): Scale to use, can be MelType.HTK or MelType.SLANEY. Default: MelType.HTK.
+        norm (NormType, optional): Normalization method, can be ``NormType.NONE`` or ``NormType.SLANEY``.
+            Default: ``NormType.NONE``.
+        mel_type (MelType, optional): Scale to use, can be ``MelType.HTK`` or ``MelType.SLANEY``.
+            Default: ``MelType.HTK``.
 
     Returns:
         numpy.ndarray, the frequency transformation matrix with shape ( `n_freqs` , `n_mels` ).

mindspore/dataset/callback/ds_callback.py

@@ -32,20 +32,49 @@ class DSCallback:
 
     Args:
         step_size (int, optional): The number of steps between adjacent `ds_step_begin`/`ds_step_end`
-            calls. Default: 1, will be called at each step.
+            calls. Default: ``1``, will be called at each step.
 
     Examples:
+        >>> import mindspore.dataset as ds
         >>> from mindspore.dataset import DSCallback
-        >>> from mindspore.dataset.transforms import transforms
         >>>
         >>> class PrintInfo(DSCallback):
+        ...     def ds_begin(self, ds_run_context):
+        ...         print("callback: start dataset pipeline", flush=True)
+        ...
+        ...     def ds_epoch_begin(self, ds_run_context):
+        ...         print("callback: epoch begin, we are in epoch", ds_run_context.cur_epoch_num, flush=True)
+        ...
         ...     def ds_epoch_end(self, ds_run_context):
-        ...         print(ds_run_context.cur_epoch_num)
-        ...         print(ds_run_context.cur_step_num)
+        ...         print("callback: epoch end, we are in epoch", ds_run_context.cur_epoch_num, flush=True)
+        ...
+        ...     def ds_step_begin(self, ds_run_context):
+        ...         print("callback: step begin, step", ds_run_context.cur_step_num_in_epoch, flush=True)
+        ...
+        ...     def ds_step_end(self, ds_run_context):
+        ...         print("callback: step end, step", ds_run_context.cur_step_num_in_epoch, flush=True)
         >>>
-        >>> dataset = ds.MnistDataset(mnist_dataset_dir, num_samples=100)
-        >>> op = transforms.OneHot(10)
-        >>> dataset = dataset.map(operations=op, callbacks=PrintInfo())
+        >>> dataset = ds.GeneratorDataset([1, 2], "col1", shuffle=False, num_parallel_workers=1)
+        >>> dataset = dataset.map(operations=lambda x: x, callbacks=PrintInfo())
+        >>>
+        >>> # Start dataset pipeline
+        >>> iterator = dataset.create_tuple_iterator(num_epochs=2)
+        >>> for i in range(2):
+        ...     for d in iterator:
+        ...         pass
+        callback: start dataset pipeline
+        callback: epoch begin, we are in epoch 1
+        callback: step begin, step 1
+        callback: step begin, step 2
+        callback: step end, step 1
+        callback: step end, step 2
+        callback: epoch end, we are in epoch 1
+        callback: epoch begin, we are in epoch 2
+        callback: step begin, step 1
+        callback: step begin, step 2
+        callback: step end, step 1
+        callback: step end, step 2
+        callback: epoch end, we are in epoch 2
     """
 
     @check_callback
@@ -131,7 +160,7 @@ class WaitedDSCallback(Callback, DSCallback):
     r"""
     Abstract base class used to build dataset callback classes that are synchronized with the training callback class
     `mindspore.train.Callback \
-    <https://www.mindspore.cn/docs/en/r2.0/api_python/train/
+    <https://www.mindspore.cn/docs/en/r2.2/api_python/train/
     mindspore.train.Callback.html#mindspore.train.Callback>`_ .
 
     It can be used to execute a custom callback method before a step or an epoch, such as
@@ -142,7 +171,7 @@ class WaitedDSCallback(Callback, DSCallback):
     `device_number` , `list_callback` , `cur_epoch_num` , `cur_step_num` , `dataset_sink_mode` ,
     `net_outputs` , etc., see
     `mindspore.train.Callback \
-    <https://www.mindspore.cn/docs/en/r2.0/api_python/train/
+    <https://www.mindspore.cn/docs/en/r2.2/api_python/train/
     mindspore.train.Callback.html#mindspore.train.Callback>`_ .
 
     Users can obtain the dataset pipeline context through `ds_run_context` , including
@@ -152,13 +181,13 @@ class WaitedDSCallback(Callback, DSCallback):
         Note that the call is triggered only at the beginning of the second step or epoch.
 
     Args:
-       step_size (int, optional): The number of rows in each step, usually set equal to the batch size. Default: 1.
+       step_size (int, optional): The number of rows in each step, usually set equal to the batch size. Default: ``1``.
 
     Examples:
-        >>> import mindspore.nn as nn
         >>> import mindspore as ms
-        >>> from mindspore.dataset import WaitedDSCallback
         >>> import mindspore.dataset as ds
+        >>> import mindspore.nn as nn
+        >>> from mindspore.dataset import WaitedDSCallback
         >>>
         >>> ms.set_context(mode=ms.GRAPH_MODE, device_target="CPU")
         >>>
@@ -214,7 +243,7 @@ class WaitedDSCallback(Callback, DSCallback):
         >>> data = data.map(operations=(lambda x: x), callbacks=my_cb1)
         >>>
         >>> net = Net()
-        >>> model = ms.Model(net)
+        >>> model = ms.train.Model(net)
         >>>
         >>> # add the data and network callback objects to the model training callback list
         >>> model.train(2, data, dataset_sink_mode=False, callbacks=[my_cb2, my_cb1])