mindspore 2.0.0a0__cp38-cp38-win_amd64.whl → 2.0.0rc1__cp38-cp38-win_amd64.whl

mindspore/dataset/vision/utils.py

@@ -459,7 +459,7 @@ def get_image_num_channels(image):
         int, the number of input image channels.
 
     Raises:
-        RuntimeError: If `image` has invalid dimensions which should be larger than 1.
+        RuntimeError: If the dimension of `image` is less than 2.
         TypeError: If `image` is not of type <class 'numpy.ndarray'> or <class 'PIL.Image.Image'>.
 
     Examples:
@@ -489,7 +489,7 @@ def get_image_size(image):
         list[int, int], the image size.
 
     Raises:
-        RuntimeError: If `image` has invalid dimensions which should be larger than 1.
+        RuntimeError: If the dimension of `image` is less than 2.
         TypeError: If `image` is not of type <class 'numpy.ndarray'> or <class 'PIL.Image.Image'>.
 
     Examples:
@@ -552,7 +552,7 @@ def read_image(filename, mode=ImageReadMode.UNCHANGED):
 
     Args:
         filename(str): The path to the image file to be read.
-        mode(int, optional): The mode used for decoding the image. It can be any of
+        mode(ImageReadMode, optional): The mode used for decoding the image. It can be any of
             [ImageReadMode.UNCHANGED, ImageReadMode.GRAYSCALE, IMageReadMode.COLOR]. Default: ImageReadMode.UNCHANGED.
 
             - ImageReadMode.UNCHANGED, remain the output in the original format.

mindspore/experimental/map_parameter.py

@@ -21,9 +21,10 @@ import sys
 from copy import copy
 import numbers
 import mindspore as ms
-from mindspore.common.parameter import Tensor, Parameter
+from mindspore.common.parameter import Parameter, _get_unique_parameter_key
 from mindspore._c_expression import Tensor as Tensor_
 from mindspore._c_expression import MapTensor_
+from mindspore.ops.operations import _map_tensor_ops
 
 
 class MapParameter(Parameter):
@@ -31,7 +32,7 @@ class MapParameter(Parameter):
     MapParameter is a parameter that stores a map like data structure.
 
     .. warning::
-        This is an experimental prototype that is subject to change and/or deletion.
+        This is an experimental API that is subject to change or deletion.
 
     Args:
         key_dtype (:class:`mindspore.dtype`): The data type of the key. The argument should be defined in
@@ -89,25 +90,17 @@ class MapParameter(Parameter):
         obj.init_mode = None
         obj.is_default_input_init = False
         # MapParameter added attributes.
-        if key_dtype is not None and key_tensor is not None and key_dtype != key_tensor.dtype:
-            raise ValueError(f"When initializing a MapParameter, 'key_dtype' and 'key_tensor.dtype' should be set the"
-                             f" same.")
+        MapParameter._check_map_parameter_args(key_tensor, key_dtype, value_tensor, value_dtype, value_shape)
         if key_tensor is not None:
             obj.key_dtype = key_tensor.dtype
         else:
             obj.key_dtype = key_dtype if key_dtype is not None else ms.int32
 
-        if value_dtype is not None and value_tensor is not None and value_dtype != value_tensor.dtype:
-            raise ValueError(f"When initializing a MapParameter, 'value_dtype' and 'value_tensor.dtype' should be set "
-                             f"the same.")
         if value_tensor is not None:
             obj.value_dtype = value_tensor.dtype
         else:
             obj.value_dtype = value_dtype if value_dtype is not None else ms.float32
 
-        if value_shape is not None and value_tensor is not None and value_shape != value_tensor.shape:
-            raise ValueError(f"When initializing a map_parameter, 'value_shape' and 'value_tensor.shape' should be set "
-                             f"the same.")
         if value_tensor is not None:
             obj.value_shape = value_tensor.shape
         else:
@@ -128,6 +121,8 @@ class MapParameter(Parameter):
         else:
             self._map_tensor = MapTensor_(self.key_dtype, self.value_dtype, self.value_shape, self.default_value,
                                           self.permit_filter_value, self.evict_filter_value)
+        self.map_put = _map_tensor_ops.put
+        self.map_erase = _map_tensor_ops.erase
 
     def __getitem__(self, key_tensor):
         return self.get(key_tensor, True)
@@ -143,6 +138,18 @@ class MapParameter(Parameter):
         x.__dict__.update(self.__dict__)
         return x
 
+    @staticmethod
+    def _check_map_parameter_args(key_tensor, key_dtype, value_tensor, value_dtype, value_shape):
+        if key_dtype is not None and key_tensor is not None and key_dtype != key_tensor.dtype:
+            raise ValueError(f"When initializing a MapParameter, 'key_dtype' and 'key_tensor.dtype' should be set the"
+                             f" same.")
+        if value_dtype is not None and value_tensor is not None and value_dtype != value_tensor.dtype:
+            raise ValueError(f"When initializing a MapParameter, 'value_dtype' and 'value_tensor.dtype' should be set "
+                             f"the same.")
+        if value_shape is not None and value_tensor is not None and value_shape != value_tensor.shape:
+            raise ValueError(f"When initializing a map_parameter, 'value_shape' and 'value_tensor.shape' should be set "
+                             f"the same.")
+
     def clone(self, init='same'):
         """
         Clone the MapParameter.
@@ -166,9 +173,12 @@ class MapParameter(Parameter):
             info.cloned_obj = [x]
         self.param_info = info
         if init != 'same':
-            x.default_value = init  # pylint: disable=W0201
-        x._map_tensor = MapTensor_(x.key_dtype, x.value_dtype, x.value_shape, x.default_value, x.permit_filter_value,  # pylint: disable=W0212
+            x.default_value = init
+        x._map_tensor = MapTensor_(x.key_dtype, x.value_dtype, x.value_shape, x.default_value, x.permit_filter_value,
                                    x.evict_filter_value)
+        x.cache_enable = self.cache_enable
+        if x.cache_enable:
+            x.key = _get_unique_parameter_key()
         return x
 
     def get(self, key_tensor, insert_default_value=True):
@@ -183,8 +193,8 @@ class MapParameter(Parameter):
         Returns:
             Tensor, the value tensor for the key tensor.
         """
-        result_tensor = self._map_tensor.get(key_tensor, insert_default_value)
-        return Tensor(result_tensor, internal=True)
+        map_get = _map_tensor_ops.MapTensorGet(insert_default_value)
+        return map_get(self._map_tensor, key_tensor)
 
     def get_keys(self):
         """
@@ -193,7 +203,7 @@ class MapParameter(Parameter):
         Returns:
             Tensor, the tensor contains all keys.
         """
-        return self.key_tensor
+        return self._map_tensor.get_keys()
 
     def get_values(self):
         """
@@ -202,7 +212,7 @@ class MapParameter(Parameter):
         Returns:
             Tensor, the tensor contains all values.
         """
-        return self.value_tensor
+        return self._map_tensor.get_values()
 
     def get_data(self):
         """
@@ -211,8 +221,7 @@ class MapParameter(Parameter):
         Returns:
             Tensor, the tensor contains all keys and values.
         """
-        return self.key_tensor, self.value_tensor
-
+        return self._map_tensor.get_data()
 
     def put(self, key_tensor, value_tensor):
         """
@@ -225,8 +234,8 @@ class MapParameter(Parameter):
         Returns:
             MapParameter, the MapParameter object itself.
         """
-        self._map_tensor.put(key_tensor, value_tensor)
-        return self
+        self.map_put(self._map_tensor, key_tensor, value_tensor)
+        return self._map_tensor
 
     def erase(self, key_tensor):
         """
@@ -238,20 +247,23 @@ class MapParameter(Parameter):
         Returns:
             MapParameter, the MapParameter object itself.
         """
-        self._map_tensor.erase(key_tensor)
-        return self
+        self.map_erase(self._map_tensor, key_tensor)
+        return self._map_tensor
 
-    def export_data(self, full=False):
+    def export_data(self, incremental=False):
         """
         Export data from this map parameter.
 
         Args:
-            full (bool): True for full export, otherwise for incremental export. Default: False.
+            incremental (bool): False for full export, otherwise for incremental export. Default: False.
+            When exporting data incrementally, the value_array does not contain erased data, so the length of the
+            key_array and the length of the value_array may be inconsistent.The length of the key_array and the length
+            of the status_array are consistent.
 
         Returns:
             Tuple(key_array, value_array, status_array), The exported data as a tuple.
         """
-        return self._map_tensor.export_data(full)
+        return self._map_tensor.export_data(incremental)
 
     def import_data(self, data):
         """

mindspore/include/OWNERS

@@ -1,6 +1,5 @@
 approvers:
 - zhoufeng54
-- sunsuodong
 - zhang_xue_tong
 - jpc_chenjianping
 reviewers:

mindspore/include/api/callback/callback.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
 #include <utility>
 #include "include/api/data_type.h"
 #include "include/api/dual_abi_helper.h"
+#include "include/api/types.h"
 
 namespace mindspore {
 class Model;
@@ -31,24 +32,19 @@ class CallbackImpl;
 
 using GraphPoint = std::pair<int, float>;
 
-struct TrainCallBackData {
-  TrainCallBackData(bool train_mode, int epoch, int step, Model *model): train_mode_(train_mode), epoch_(epoch),
-                    step_(step), model_(model) {}
+struct MS_API TrainCallBackData {
+  TrainCallBackData(bool train_mode, int epoch, int step, Model *model)
+      : train_mode_(train_mode), epoch_(epoch), step_(step), model_(model) {}
 
   bool train_mode_;       /**< training mode of LiteSession object */
   unsigned int epoch_;    /**< the current training epoch (starts at 0) */
   unsigned int step_ = 0; /**< the current step within the epoch */
-  Model *model_;  /**< pointer to the Model object */
+  Model *model_;          /**< pointer to the Model object */
 };
 
-enum CallbackRetValue : uint32_t {
-  kContinue = 0,
-  kStopTraining = 1,
-  kExit = 2,
-  kUnknownRetValue = 0xFFFFFFFF
-};
+enum CallbackRetValue : uint32_t { kContinue = 0, kStopTraining = 1, kExit = 2, kUnknownRetValue = 0xFFFFFFFF };
 
-class TrainCallBack {
+class MS_API TrainCallBack {
  public:
   virtual ~TrainCallBack() = default;
 
@@ -90,7 +86,7 @@ class TrainCallBack {
  protected:
   friend class Model;
   friend class ModelImpl;
-  CallbackImpl* callback_impl_ = nullptr;
+  CallbackImpl *callback_impl_ = nullptr;
 };
 
 }  // namespace mindspore

mindspore/include/api/callback/ckpt_saver.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
 
 namespace mindspore {
 
-class CkptSaver: public TrainCallBack {
+class MS_API CkptSaver : public TrainCallBack {
  public:
   inline CkptSaver(int save_every_n, const std::string &filename_prefix);
   virtual ~CkptSaver();

mindspore/include/api/callback/loss_monitor.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@
 
 namespace mindspore {
 
-class LossMonitor: public TrainCallBack {
+class MS_API LossMonitor : public TrainCallBack {
  public:
   explicit LossMonitor(int print_every_n_steps = INT_MAX);
   virtual ~LossMonitor();

mindspore/include/api/callback/lr_scheduler.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,18 +30,18 @@ constexpr int UPDATE_LR = 1;
 using LR_Lambda = std::function<int(float *lr, int epoch, void *cb_data)>;
 
 /// \brief Multiply the LR by a factor of gamma every epoch
-int MultiplicativeLRLambda(float *lr, int epoch, void *multiplication);
+MS_API int MultiplicativeLRLambda(float *lr, int epoch, void *multiplication);
 
 /// \brief Multiply the LR by a factor of gamma every step_size
-int StepLRLambda(float *lr, int epoch, void *step_size);
-struct StepLRLambda {
+MS_API int StepLRLambda(float *lr, int epoch, void *step_size);
+struct MS_API StepLRLambda {
   StepLRLambda(int step, float g) : step_size(step), gamma(g) {}
 
   int step_size;  // period of LR decay
   float gamma;    // LR decay factor
 };
 
-class LRScheduler: public TrainCallBack {
+class MS_API LRScheduler : public TrainCallBack {
  public:
   explicit LRScheduler(LR_Lambda lambda_func, void *lr_cb_data = nullptr, int step = 1);
   virtual ~LRScheduler();

mindspore/include/api/callback/time_monitor.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@
 
 namespace mindspore {
 
-class TimeMonitor: public TrainCallBack {
+class MS_API TimeMonitor : public TrainCallBack {
  public:
   virtual ~TimeMonitor() = default;
   void EpochBegin(const TrainCallBackData &cb_data) override;

mindspore/include/api/callback/train_accuracy.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,12 +26,10 @@
 
 namespace mindspore {
 
-class TrainAccuracy: public TrainCallBack {
+class MS_API TrainAccuracy : public TrainCallBack {
  public:
-  explicit TrainAccuracy(int print_every_n = INT_MAX,
-                         int accuracy_metrics = METRICS_CLASSIFICATION,
-                         const std::vector<int> &input_indexes = {1},
-                         const std::vector<int> &output_indexes = {0});
+  explicit TrainAccuracy(int print_every_n = INT_MAX, int accuracy_metrics = METRICS_CLASSIFICATION,
+                         const std::vector<int> &input_indexes = {1}, const std::vector<int> &output_indexes = {0});
   virtual ~TrainAccuracy();
   const std::vector<GraphPoint> &GetAccuracyPoints();
 };

mindspore/include/api/cfg.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2022 Huawei Technologies Co., Ltd
+ * Copyright 2022-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@
 
 namespace mindspore {
 constexpr int iter_th = 1000;
-class MixPrecisionCfg {
+class MS_API MixPrecisionCfg {
  public:
   MixPrecisionCfg() {
     this->dynamic_loss_scale_ = false;
@@ -49,7 +49,7 @@ class MixPrecisionCfg {
   bool is_raw_mix_precision_ = false; /**< Is mix precision model export from mindspore  */
 };
 
-class TrainCfg {
+class MS_API TrainCfg {
  public:
   TrainCfg() = default;
   TrainCfg(const TrainCfg &rhs) {
@@ -59,11 +59,24 @@ class TrainCfg {
   }
   ~TrainCfg() = default;
 
+  /// \brief obtain part of the name that identify a loss kernel.
+  ///
+  /// \return loss_name.
+  inline std::vector<std::string> GetLossName() const;
+  /// \brief Set part of the name that identify a loss kernel.
+  ///
+  /// \param[in] loss_name define part of the name that identify a loss kernel.
+  inline void SetLossName(const std::vector<std::string> &loss_name);
+
   OptimizationLevel optimization_level_ = kO0;
-  std::vector<std::string> loss_name_ = {
-    "loss_fct", "_loss_fn", "SigmoidCrossEntropy"}; /**< Set part of the name that identify a loss kernel */
-  MixPrecisionCfg mix_precision_cfg_;               /**< Mix precision configuration */
+  MixPrecisionCfg mix_precision_cfg_; /**< Mix precision configuration */
   bool accumulate_gradients_ = false;
+
+ private:
+  std::vector<std::vector<char>> loss_name_ = VectorStringToChar({"loss_fct", "_loss_fn", "SigmoidCrossEntropy"});
 };
+
+std::vector<std::string> TrainCfg::GetLossName() const { return VectorCharToString(loss_name_); }
+void TrainCfg::SetLossName(const std::vector<std::string> &loss_name) { loss_name_ = VectorStringToChar(loss_name); }
 }  // namespace mindspore
 #endif  // MINDSPORE_INCLUDE_API_CFG_H

mindspore/include/api/context.h

@@ -37,6 +37,8 @@ enum DeviceType {
   kAscend,
   kAscend910,
   kAscend310,
+  kCustomDevice,
+  kAllDevice,
   // add new type here
   kInvalidDeviceType = 100,
 };
@@ -52,6 +54,7 @@ class MS_API Context {
   struct Data;
   Context();
   ~Context() = default;
+  Context(const Context &rhs) : data_(rhs.data_) {}
 
   /// \brief Set the number of threads at runtime.
   ///
@@ -182,16 +185,17 @@ class MS_API DeviceInfoContext : public std::enable_shared_from_this<DeviceInfoC
   ///
   /// \return provider's name.
   inline std::string GetProvider() const;
+
   /// \brief set provider's name.
   ///
   /// \param[in] provider define the provider's name.
-
   inline void SetProvider(const std::string &provider);
+
   /// \brief obtain provider's device type.
   ///
   /// \return provider's device type.
-
   inline std::string GetProviderDevice() const;
+
   /// \brief set provider's device type.
   ///
   /// \param[in] device define the provider's device type.EG: CPU.
@@ -221,6 +225,16 @@ void DeviceInfoContext::SetProvider(const std::string &provider) { SetProvider(S
 std::string DeviceInfoContext::GetProviderDevice() const { return CharToString(GetProviderDeviceChar()); }
 void DeviceInfoContext::SetProviderDevice(const std::string &device) { SetProviderDevice(StringToChar(device)); }
 
+/// \brief Derived from DeviceInfoContext, The configuration of the model running auto on the Host Devices, include
+/// CPU/GPU/NPU/Ascend310/Ascend910. This option is only valid for MindSpore Lite.
+class MS_API AutoDeviceInfo : public DeviceInfoContext {
+ public:
+  /// \brief Get the type of this DeviceInfoContext.
+  ///
+  /// \return Type of this DeviceInfoContext.
+  enum DeviceType GetDeviceType() const override { return DeviceType::kAllDevice; };
+};
+
 /// \brief Derived from DeviceInfoContext, The configuration of the model running on the CPU. This option is only valid
 /// for MindSpore Lite.
 class MS_API CPUDeviceInfo : public DeviceInfoContext {
@@ -391,7 +405,7 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
 
   /// \brief Set format of model inputs.
   ///
-  /// \param[in] format Optional "NCHW", "NHWC", etc.
+  /// \param[in] format Optional "NCHW", "NHWC", and "ND".
   inline void SetInputFormat(const std::string &format);
 
   /// \brief Get format of model inputs.
@@ -401,7 +415,7 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
 
   /// \brief Set shape of model inputs.
   ///
-  /// \param[in] shape e.g. "input_op_name1: 1,2,3,4;input_op_name2: 4,3,2,1".
+  /// \param[in] shape e.g. "input_op_name1:1,2,3,4;input_op_name2:4,3,2,1".
   inline void SetInputShape(const std::string &shape);
 
   /// \brief Get shape of model inputs.
@@ -411,7 +425,7 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
 
   /// \brief Set shape of model inputs.
   ///
-  /// \param[in] shape e.g. {{1, {1,2,3,4}}, {2, {4,3,2,1}}} means the first input shape 1,2,3,4 and the second input
+  /// \param[in] shape e.g. {{0, {1,2,3,4}}, {1, {4,3,2,1}}} means the first input shape 1,2,3,4 and the second input
   /// shape 4,3,2,1.
   void SetInputShapeMap(const std::map<int, std::vector<int>> &shape);
 
@@ -420,7 +434,14 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
   /// \return The shape of model inputs.
   std::map<int, std::vector<int>> GetInputShapeMap() const;
 
+  /// \brief Set dynamic batch sizes of model inputs. Ranges from 2 to 100.
+  ///
+  /// \param[in] dynamic_batch_size e.g. {1, 2} means batch size 1 and 2 are configured.
   void SetDynamicBatchSize(const std::vector<size_t> &dynamic_batch_size);
+
+  /// \brief Get dynamic batch sizes of model inputs.
+  ///
+  /// \return The dynamic batch sizes of model inputs in string format.
   inline std::string GetDynamicBatchSize() const;
 
   /// \brief Set the dynamic image size of model inputs.
@@ -435,7 +456,7 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
 
   /// \brief Set type of model outputs.
   ///
-  /// \param[in] output_type FP32, UINT8 or FP16, default as FP32.
+  /// \param[in] output_type FP32, UINT8 or FP16.
   void SetOutputType(enum DataType output_type);
 
   /// \brief Get type of model outputs.
@@ -445,8 +466,8 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
 
   /// \brief Set precision mode of model.
   ///
-  /// \param[in] precision_mode Optional "force_fp16", "allow_fp32_to_fp16", "must_keep_origin_dtype" and
-  /// "allow_mix_precision", "force_fp16" is set as default
+  /// \param[in] precision_mode Optional "enforce_fp16", "preferred_fp32", "enforce_origin", "enforce_fp32" and
+  /// "preferred_optimal", "enforce_fp16" is set as default
   inline void SetPrecisionMode(const std::string &precision_mode);
 
   /// \brief Get precision mode of model.
@@ -465,11 +486,25 @@ class MS_API AscendDeviceInfo : public DeviceInfoContext {
   /// \return The set op select implementation mode.
   inline std::string GetOpSelectImplMode() const;
 
+  /// \brief Set fusion switch config file path. Controls which fusion passes to be turned off.
+  ///
+  /// \param[in] cfg_path fusion switch config file path.
   inline void SetFusionSwitchConfigPath(const std::string &cfg_path);
+
+  /// \brief Get fusion switch config file path.
+  ///
+  /// \return The fusion switch config file path.
   inline std::string GetFusionSwitchConfigPath() const;
 
-  // Optional "l1_optimize", "l2_optimize", "off_optimize" or "l1_and_l2_optimize", default as "l2_optimize"
+  /// \brief Set buffer optimize mode.
+  ///
+  /// \param[in] buffer_optimize_mode Optional "l1_optimize", "l2_optimize", "off_optimize" or "l1_and_l2_optimize",
+  /// default as "l2_optimize".
   inline void SetBufferOptimizeMode(const std::string &buffer_optimize_mode);
+
+  /// \brief Get buffer optimize mode.
+  ///
+  /// \return The buffer optimize mode.
   inline std::string GetBufferOptimizeMode() const;
 
  private:

mindspore/include/api/delegate.h

@@ -50,7 +50,7 @@ class MS_API DelegateModel {
 
   /// \brief Get Primitive of kernel::Kernel.
   ///
-  /// \param[in] a kernel in DelegateModel kernels vector.
+  /// \param[in] kernel kernel in DelegateModel kernels vector.
   ///
   /// \return The Primitive of The kernel.
   const T *GetPrimitive(kernel::Kernel *kernel) const {

mindspore/include/api/metrics/accuracy.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace mindspore {
 constexpr int METRICS_CLASSIFICATION = 0;
 constexpr int METRICS_MULTILABEL = 1;
 
-class AccuracyMetrics : public Metrics {
+class MS_API AccuracyMetrics : public Metrics {
  public:
   explicit AccuracyMetrics(int accuracy_metrics = METRICS_CLASSIFICATION, const std::vector<int> &input_indexes = {1},
                            const std::vector<int> &output_indexes = {0});

mindspore/include/api/metrics/metrics.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Huawei Technologies Co., Ltd
+ * Copyright 2021-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,16 +24,17 @@ class MetricsImpl;
 class ModelImpl;
 class MSTensor;
 
-class Metrics {
+class MS_API Metrics {
  public:
   virtual ~Metrics() = default;
   virtual void Clear() {}
   virtual float Eval() { return 0.0; }
   virtual void Update(std::vector<MSTensor *> inputs, std::vector<MSTensor *> outputs) {}
+
  protected:
   friend class Model;
   friend class ModelImpl;
-  MetricsImpl* metrics_impl_;
+  MetricsImpl *metrics_impl_;
 };
 
 }  // namespace mindspore

mindspore/include/api/model.h

@@ -151,7 +151,7 @@ class MS_API Model {
   /// \return Status.
   Status UpdateWeights(const std::vector<MSTensor> &new_weights);
 
-  /// \brief Inference model.
+  /// \brief Inference model API. If use this API in train mode, it's equal to RunStep API.
   ///
   /// \param[in] inputs A vector where model inputs are arranged in sequence.
   /// \param[out] outputs Which is a pointer to a vector. The model outputs are filled in the container in sequence.
@@ -162,7 +162,7 @@ class MS_API Model {
   Status Predict(const std::vector<MSTensor> &inputs, std::vector<MSTensor> *outputs,
                  const MSKernelCallBack &before = nullptr, const MSKernelCallBack &after = nullptr);
 
-  /// \brief Inference model.
+  /// \brief Inference model API. If use this API in train mode, it's equal to RunStep API.
   ///
   /// \param[in] before CallBack before predict.
   /// \param[in] after CallBack after predict.
@@ -170,7 +170,7 @@ class MS_API Model {
   /// \return Status.
   Status Predict(const MSKernelCallBack &before = nullptr, const MSKernelCallBack &after = nullptr);
 
-  /// \brief Run model by step.
+  /// \brief Training API. Run model by step.
   ///
   /// \param[in] before CallBack before RunStep.
   /// \param[in] after CallBack after RunStep.
@@ -240,9 +240,14 @@ class MS_API Model {
 
   /// \brief Obtain all weights tensors of the model.
   ///
-  /// \return The vector that includes all gradient tensors.
+  /// \return The vector that includes all weights tensors.
   std::vector<MSTensor> GetFeatureMaps() const;
 
+  /// \brief Obtain all trainable parameters of the model optimizers.
+  ///
+  /// \return The vector that includes all trainable parameters.
+  std::vector<MSTensor> GetTrainableParams() const;
+
   /// \brief Update weights tensors of the model.
   ///
   /// \param[in] new_weights A vector new weights.

mindspore/include/api/model_parallel_runner.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2022 Huawei Technologies Co., Ltd
+ * Copyright 2022-2023 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
 namespace mindspore {
 /// \brief The RunnerConfig class  is used to store environment variables during execution
 /// management.
-class RunnerConfig {
+class MS_API RunnerConfig {
  public:
   struct Data;
   RunnerConfig();