1 /** 2 * Copyright 2020 Huawei Technologies Co., Ltd 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef MINDSPORE_CORE_OPS_SGD_H_ 18 #define MINDSPORE_CORE_OPS_SGD_H_ 19 #include <vector> 20 #include <memory> 21 #include "ops/primitive_c.h" 22 #include "ops/op_utils.h" 23 #include "abstract/abstract_value.h" 24 25 namespace mindspore { 26 namespace ops { 27 constexpr auto kNameSGD = "SGD"; 28 /// \brief Computes the stochastic gradient descent. 29 /// Refer to Python API @ref mindspore.ops.SGD for more details. 30 class MS_CORE_API SGD : public PrimitiveC { 31 public: 32 /// \brief Constructor. SGD()33 SGD() : PrimitiveC(kNameSGD) {} 34 /// \brief Destructor. 35 ~SGD() = default; 36 MS_DECLARE_PARENT(SGD, PrimitiveC); 37 /// \brief Init. Refer to the parameters of Python API @ref mindspore.ops.SGD for the inputs. 38 void Init(const float dampening = 0.0, const float weight_decay = 0.0, const bool nesterov = false); 39 /// \brief Set dampening. 40 void set_dampening(const float dampening); 41 /// \brief Set weight_decay. 42 void set_weight_decay(const float weight_decay); 43 /// \brief Set nesterov. 44 void set_nesterov(const bool nesterov); 45 /// \brief Get dampening. 46 /// 47 /// \return dampening. 48 float get_dampening() const; 49 /// \brief Get weight_decay. 50 /// 51 /// \return weight_decay. 52 float get_weight_decay() const; 53 /// \brief Get nesterov. 54 /// 55 /// \return nesterov. 56 bool get_nesterov() const; 57 }; 58 AbstractBasePtr SGDInfer(const abstract::AnalysisEnginePtr &, const PrimitivePtr &primitive, 59 const std::vector<AbstractBasePtr> &input_args); 60 using PrimSGD = std::shared_ptr<SGD>; 61 } // namespace ops 62 } // namespace mindspore 63 #endif // MINDSPORE_CORE_OPS_SGD_H_ 64