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