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_ADAM_H_ 18 #define MINDSPORE_CORE_OPS_ADAM_H_ 19 #include <map> 20 #include <memory> 21 #include <string> 22 #include <vector> 23 #include "mindapi/base/types.h" 24 #include "ops/base_operator.h" 25 26 namespace mindspore { 27 namespace ops { 28 constexpr auto kNameAdam = "Adam"; 29 /// \brief Updates gradients by the Adaptive Moment Estimation (Adam) algorithm. 30 /// Refer to Python API @ref mindspore.ops.Adam for more details. 31 class MIND_API Adam : public BaseOperator { 32 public: 33 MIND_API_BASE_MEMBER(Adam); 34 /// \brief Constructor. Adam()35 Adam() : BaseOperator(kNameAdam) {} 36 /// \brief Init. Refer to the parameters of Python API @ref mindspore.ops.Adam for the inputs. 37 void Init(const bool use_locking = false, const bool use_nesterov = false); 38 /// \brief Set use_locking. 39 void set_use_locking(const bool use_locking); 40 /// \brief Set use_nesterov. 41 void set_use_nesterov(const bool use_nesterov); 42 /// \brief Get use_locking. 43 /// 44 /// \return use_locking. 45 bool get_use_locking() const; 46 /// \brief Get use_nesterov. 47 /// 48 /// \return use_nesterov. 49 bool get_use_nesterov() const; 50 }; 51 using kPrimAdamPtr = std::shared_ptr<Adam>; 52 MIND_API abstract::AbstractBasePtr ApplyAdamInferFunc(const abstract::AnalysisEnginePtr &, 53 const PrimitivePtr &primitive, 54 const std::vector<abstract::AbstractBasePtr> &input_args); 55 } // namespace ops 56 } // namespace mindspore 57 58 #endif // MINDSPORE_CORE_OPS_ADAM_H_ 59